| Property | Value |
| Model name | IBPDI CDM V0.1.1-beta |
| Technical name | |
| Description | |
| Author | |
| DB vendor | JSON |
| Version | |
| Comments | |
| Lineage |
| Property | Value |
| Group name | DigitalTwin |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
| Property | Value |
| Document name | AreaMeasurement |
| Technical name | ArMsrmnt |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| Standard | string | true | Area measurement standard | ||
| Type | string | true | Type of the standard area | ||
| Value | number | true | Value of measurement | [{"dataType":"float"}] | |
| Unit | string | true | Unit area is measured with | ||
| ValidFrom | date-time | true | Date measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date measurement is not valid anymore /needs to be renewed in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312 |
| Comments |
| Property | Value |
| Name | Standard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Area measurement standard |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | DIN 277-1,MFG,IPMS,RICS,BOMA,Not defined |
| Sample | Din 277-1 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of the standard area |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Gross floor area,Construction area,Net room area,Circulation area,Net usable area,Technical area,Living/residence area,Office area,Production / laboratory area,Storage/distribution/selling area,Education/teaching/culture area,Healing/care area,Other uses,Rentable exclusion,Rentable area,Rentable area common occupancy,Rentable area exclusive occupancy,Gross external area,External Wall area,Gross internal area,A-Vertical penetrations,B-Structural elements,C-Technical services,D-Hygiene areas,E-Circulation areas,F-Amenities,G-Workspace,H-Other areas,Boundary area,Rentable area common occupancy,Building amenity area,Building service area,Floor service area,Rentable area exclusive occupancy,Tenant ancillary area,Tenant area,Major vertical penetrations,Occupant Storage area,Parking area,Unenclosed Building Feature : Covered Gallery,Vacant area,Not defined |
| Sample | G-Workspace |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | Vl |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of measurement |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 230.45 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Unit |
| Technical name | Unt |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit area is measured with |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | square meter,square feet |
| Sample | square meter |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | New Relationship(4) |
| Cardinality | 1 |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-25 12:09:21 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date measurement is not valid anymore /needs to be renewed in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-06-22 07:27:21 |
| Comments | [{"dataType":"dateTime"}] |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurement",
"additionalProperties": false,
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Standard": {
"type": "string",
"description": "Area measurement standard",
"enum": [
"DIN 277-1",
"MFG",
"IPMS",
"RICS",
"BOMA",
"Not defined"
],
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of the standard area",
"enum": [
"Gross floor area",
"Construction area",
"Net room area",
"Circulation area",
"Net usable area",
"Technical area",
"Living/residence area",
"Office area",
"Production / laboratory area",
"Storage/distribution/selling area",
"Education/teaching/culture area",
"Healing/care area",
"Other uses",
"Rentable exclusion",
"Rentable area",
"Rentable area common occupancy",
"Rentable area exclusive occupancy",
"Gross external area",
"External Wall area",
"Gross internal area",
"A-Vertical penetrations",
"B-Structural elements",
"C-Technical services",
"D-Hygiene areas",
"E-Circulation areas",
"F-Amenities",
"G-Workspace",
"H-Other areas",
"Boundary area",
"Rentable area common occupancy",
"Building amenity area",
"Building service area",
"Floor service area",
"Rentable area exclusive occupancy",
"Tenant ancillary area",
"Tenant area",
"Major vertical penetrations",
"Occupant Storage area",
"Parking area",
"Unenclosed Building Feature : Covered Gallery",
"Vacant area",
"Not defined"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Vl": {
"type": "number",
"description": "Value of measurement",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"Unt": {
"type": "string",
"description": "Unit area is measured with",
"enum": [
"square meter",
"square feet"
],
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "Date measurement is not valid anymore /needs to be renewed in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"default": "2199-12-31 00:00:00"
}
},
"required": [
"AreaMeasurementId",
"Standard",
"Type",
"Vl",
"Unt",
"ValidFrom",
"ValidUntil"
]
}{
"AreaMeasurementId": "AM-CH-SE-2312",
"Standard": "Din 277-1",
"Type": "G-Workspace",
"Vl": 230.45,
"Unt": "square meter",
"ValidFrom": "2021-03-25 12:09:21",
"ValidUntil": "2025-06-22 07:27:21"
}| Property | Value |
| Document name | Building |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | User specific building name e.g: EMEA Headquarter, Office Berlin | ||
| BuildingCode | string | false | User specific Building Code | ||
| PrimaryTypeOfBuilding | string | true | Type of building use | ||
| SecondaryTypeOfBuilding | string | false | Second type of building use | ||
| EnergyEfficiencyClass | string | false | Energy Efficiency Class of Building | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ConstructionYear | date-time | false | Year of construction in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| YearOfLastRefurbishment | date-time | false | Year of last refurbishment took place in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| MonumentProtection | boolean | false | The building is declared to be an ancient monument with national importance by the government | ||
| TypeOfOwnership | string | true | Is the building owned or leased. | ||
| SelfUse | boolean | true | Is building self used or not (Y/N) | ||
| TenantStructure | string | true | Is there multiple tenants in the building or only one | ||
| ParkingSpaces | integer | false | Number of parking spaces | ||
| PrimaryEnergyType | string | false | Type of energy used | ||
| PrimaryWaterType | string | false | Type of water used | ||
| PrimaryHeatingType | string | false | Primary Type of heating | ||
| SecondaryHeatingType | string | false | Secondary Type of heating | ||
| AirConditioning | boolean | false | Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building) | ||
| SiteId | string | true | fk | Reference to the Site which the building belongs to |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific building name e.g: EMEA Headquarter, Office Berlin |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | HQ Berlin |
| Comments |
| Property | Value |
| Name | BuildingCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Building Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BC001 |
| Comments |
| Property | Value |
| Name | PrimaryTypeOfBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of building use |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Retail,Retail, High Street,Retail, Retail Centers,Retail, Restaurants/Bars,Retail, Other,Office,Office, Corporate,Office, Medical Office,Office, Business Park,Office, Other,Industrial,Industrial, Distribution Warehouse,Industrial, Industrial Park,Industrial, Manufacturing,Industrial, Other,Residential,Residential, Multi-Family,Residential, Family Homes,Residential, Student Housing,Residential, Retirement Living,Residential, Other,Lodging, Leisure & Recreation,Hotel,Education,Technology/Science,Health Care,Health Care, Health Care Center,Health Care, Senior Homes,Health Care, Other,Mixed Use,Other |
| Sample | Industrial, Manufacturing |
| Comments |
| Property | Value |
| Name | SecondaryTypeOfBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Second type of building use |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Retail,Retail, High Street,Retail, Retail Centers,Retail, Restaurants/Bars,Retail, Other,Office,Office, Corporate,Office, Medical Office,Office, Business Park,Office, Other,Industrial,Industrial, Distribution Warehouse,Industrial, Industrial Park,Industrial, Manufacturing,Industrial, Other,Residential,Residential, Multi-Family,Residential, Family Homes,Residential, Student Housing,Residential, Retirement Living,Residential, Other,Lodging, Leisure & Recreation,Hotel,Education,Technology/Science,Health Care,Health Care, Health Care Center,Health Care, Senior Homes,Health Care, Other,Mixed Use,Other |
| Sample | Industrial, Manufacturing |
| Comments |
| Property | Value |
| Name | EnergyEfficiencyClass |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Energy Efficiency Class of Building |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | A++,A+,A,B,C,D,E,F,G,H |
| Sample | C |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | VldFrm |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-12 11:02:35 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | Vldntl |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-01-25 12:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ConstructionYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Year of construction in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-01-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | YearOfLastRefurbishment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Year of last refurbishment took place in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-01-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | MonumentProtection |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | The building is declared to be an ancient monument with national importance by the government |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | TypeOfOwnership |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Is the building owned or leased. |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Owner,Tenant |
| Sample | Owner |
| Comments |
| Property | Value |
| Name | SelfUse |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is building self used or not (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | TenantStructure |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Is there multiple tenants in the building or only one |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Single-tenant,Multi-tenant |
| Sample | Single-tenant |
| Comments |
| Property | Value |
| Name | ParkingSpaces |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Number of parking spaces |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 89 |
| Comments |
| Property | Value |
| Name | PrimaryEnergyType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of energy used |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Natural Gas,Coal,Nuclear,Petroleum,Hydropower,Wind,Biomass,Geothermal,Solar |
| Sample | |
| Comments |
| Property | Value |
| Name | PrimaryWaterType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of water used |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | PrimaryHeatingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Primary Type of heating |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | District Heating,Natural Gas,Oil-based fuels,Solar Thermal |
| Sample | District Heating |
| Comments |
| Property | Value |
| Name | SecondaryHeatingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Secondary Type of heating |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | District Heating,Natural Gas,Oil-based fuels,Solar Thermal |
| Sample | Solar Thermal |
| Comments |
| Property | Value |
| Name | AirConditioning |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | Std |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Site which the building belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Building",
"additionalProperties": false,
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "User specific building name e.g: EMEA Headquarter, Office Berlin",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingCode": {
"type": "string",
"description": "User specific Building Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryTypeOfBuilding": {
"type": "string",
"description": "Type of building use",
"enum": [
"Retail",
"Retail, High Street",
"Retail, Retail Centers",
"Retail, Restaurants/Bars",
"Retail, Other",
"Office",
"Office, Corporate",
"Office, Medical Office",
"Office, Business Park",
"Office, Other",
"Industrial",
"Industrial, Distribution Warehouse",
"Industrial, Industrial Park",
"Industrial, Manufacturing",
"Industrial, Other",
"Residential",
"Residential, Multi-Family",
"Residential, Family Homes",
"Residential, Student Housing",
"Residential, Retirement Living",
"Residential, Other",
"Lodging, Leisure & Recreation",
"Hotel",
"Education",
"Technology/Science",
"Health Care",
"Health Care, Health Care Center",
"Health Care, Senior Homes",
"Health Care, Other",
"Mixed Use",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryTypeOfBuilding": {
"type": "string",
"description": "Second type of building use",
"enum": [
"Retail",
"Retail, High Street",
"Retail, Retail Centers",
"Retail, Restaurants/Bars",
"Retail, Other",
"Office",
"Office, Corporate",
"Office, Medical Office",
"Office, Business Park",
"Office, Other",
"Industrial",
"Industrial, Distribution Warehouse",
"Industrial, Industrial Park",
"Industrial, Manufacturing",
"Industrial, Other",
"Residential",
"Residential, Multi-Family",
"Residential, Family Homes",
"Residential, Student Housing",
"Residential, Retirement Living",
"Residential, Other",
"Lodging, Leisure & Recreation",
"Hotel",
"Education",
"Technology/Science",
"Health Care",
"Health Care, Health Care Center",
"Health Care, Senior Homes",
"Health Care, Other",
"Mixed Use",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnergyEfficiencyClass": {
"type": "string",
"description": "Energy Efficiency Class of Building",
"enum": [
"A++",
"A+",
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H"
],
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"VldFrm": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"Vldntl": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ConstructionYear": {
"type": "string",
"description": "Year of construction in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00.",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"YearOfLastRefurbishment": {
"type": "string",
"description": "Year of last refurbishment took place in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00.",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"MonumentProtection": {
"type": "boolean",
"description": "The building is declared to be an ancient monument with national importance by the government"
},
"TypeOfOwnership": {
"type": "string",
"description": "Is the building owned or leased.",
"enum": [
"Owner",
"Tenant"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SelfUse": {
"type": "boolean",
"description": "Is building self used or not (Y/N)"
},
"TenantStructure": {
"type": "string",
"description": "Is there multiple tenants in the building or only one",
"enum": [
"Single-tenant",
"Multi-tenant"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ParkingSpaces": {
"type": "integer",
"description": "Number of parking spaces",
"maximum": 9999,
"minimum": 0
},
"PrimaryEnergyType": {
"type": "string",
"description": "Type of energy used",
"minLength": 1,
"maxLength": 50,
"enum": [
"Natural Gas",
"Coal",
"Nuclear",
"Petroleum",
"Hydropower",
"Wind",
"Biomass",
"Geothermal",
"Solar"
],
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryWaterType": {
"type": "string",
"description": "Type of water used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryHeatingType": {
"type": "string",
"description": "Primary Type of heating",
"enum": [
"District Heating",
"Natural Gas",
"Oil-based fuels",
"Solar Thermal"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryHeatingType": {
"type": "string",
"description": "Secondary Type of heating",
"enum": [
"District Heating",
"Natural Gas",
"Oil-based fuels",
"Solar Thermal"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AirConditioning": {
"type": "boolean",
"description": "Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building)"
},
"Std": {
"type": "string",
"description": "Reference to the Site which the building belongs to",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"Name",
"PrimaryTypeOfBuilding",
"VldFrm",
"Vldntl",
"TypeOfOwnership",
"SelfUse",
"TenantStructure",
"Std"
]
}{
"BuildingId": "SE-CH-2341",
"Name": "HQ Berlin",
"BuildingCode": "BC001",
"PrimaryTypeOfBuilding": "Industrial, Manufacturing",
"SecondaryTypeOfBuilding": "Industrial, Manufacturing",
"EnergyEfficiencyClass": "C",
"VldFrm": "2021-03-12 11:02:35",
"Vldntl": "2025-01-25 12:00:00",
"ConstructionYear": "2022-01-01 00:00:00",
"YearOfLastRefurbishment": "2021-01-01 00:00:00",
"MonumentProtection": true,
"TypeOfOwnership": "Owner",
"SelfUse": true,
"TenantStructure": "Single-tenant",
"ParkingSpaces": 89,
"PrimaryEnergyType": "Solar",
"PrimaryWaterType": "Lorem",
"PrimaryHeatingType": "District Heating",
"SecondaryHeatingType": "Solar Thermal",
"AirConditioning": true,
"Std": "AE-DE-02"
}| Property | Value |
| Document name | BuildingAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | New Relationship(6) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(6) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-23123 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "BuildingAreaMeasurement",
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"AreaMeasurementId"
]
}{
"BuildingId": "SE-CH-2341",
"AreaMeasurementId": "AM-CH-SE-23123"
}| Property | Value |
| Document name | BuildingUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | New Relationship(14) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(14) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "BuildingUnit",
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"UnitId"
]
}{
"BuildingId": "SE-CH-2341",
"UnitId": "UN-SE-CH-2341"
}| Property | Value |
| Document name | Certificate |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| Name | string | true | Name of Certificate | ||
| Type | string | true | Type of Certificate e.g: LEED, BREEAM, DGNB | ||
| Value | string | true | Score, Grade if applicable for the certificate | ||
| IssuingDate | date-time | false | Date certificate was issued in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"DateTime"}] | |
| ValidFrom | date-time | true | Date certificate is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date certificate expires in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ComponentId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Certificate |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DGNB Platin |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Certificate e.g: LEED, BREEAM, DGNB |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | LEED |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Score, Grade if applicable for the certificate |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Platin |
| Comments |
| Property | Value |
| Name | IssuingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate was issued in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-21 00:00:00 |
| Comments | [{"dataType":"DateTime"}] |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-05-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate expires in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2024-05-24 12:03:12 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to Certificate. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Certificate",
"additionalProperties": false,
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Certificate",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Certificate e.g: LEED, BREEAM, DGNB",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "string",
"description": "Score, Grade if applicable for the certificate",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"IssuingDate": {
"type": "string",
"description": "Date certificate was issued in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19
},
"ValidFrom": {
"type": "string",
"description": "Date certificate is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "Date certificate expires in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"Name",
"Type",
"Value",
"ValidFrom",
"ValidUntil"
]
}{
"CertificateId": "CE-B8-2414",
"Name": "DGNB Platin",
"Type": "LEED",
"Value": "Platin",
"IssuingDate": "2021-03-21 00:00:00",
"ValidFrom": "2022-05-21 00:00:00",
"ValidUntil": "2024-05-24 12:03:12",
"ComponentId": "C-01"
}| Property | Value |
| Document name | CertificateBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateBuilding",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"BuildingId"
]
}{
"CertificateId": "CE-B8-2414",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | CertificateComponent |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to Certificate. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateComponent",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"ComponentId"
]
}{
"CertificateId": "CE-B8-2414",
"ComponentId": "C-01"
}| Property | Value |
| Document name | CertificateSystem |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| SystemId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | System |
| Foreign field | SystemId |
| Relationship type | Foreign Key |
| Relationship name | fk System. to CertificateSystem. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | S-17281 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateSystem",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"SystemId"
]
}{
"CertificateId": "CE-B8-2414",
"SystemId": "S-17281"
}| Property | Value |
| Document name | CertificateValuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to CertificateValuation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateValuation",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"ValuationId"
]
}{
"CertificateId": "CE-B8-2414",
"ValuationId": "V021"
}| Property | Value |
| Document name | Component |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Counter | integer | false | Counter of component | ||
| ConditionStatus | string | true | Condition of component | ||
| DurationLifeYear | integer | true | Life span of component in years | [{"dataType":"integer16"}] | |
| WarrantyGuarantor | string | true | Warranty Guarantor | ||
| WarrantyStartDate | date-time | true | Warranty start date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SerialNumber | string | true | Serial number of component | ||
| TagNumber | string | false | Tag number | ||
| TypeId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Counter of component |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | ConditionStatus |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Condition of component |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Defect,Good,Not Available |
| Sample | Good |
| Comments |
| Property | Value |
| Name | DurationLifeYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Life span of component in years |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | years |
| Min value | 1 |
| Excl min | |
| Max value | 99 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 10 |
| Comments | [{"dataType":"integer16"}] |
| Property | Value |
| Name | WarrantyGuarantor |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty Guarantor |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Apple |
| Comments |
| Property | Value |
| Name | WarrantyStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty start date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-28 11:21:21 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | SerialNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Serial number of component |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | xan51425612 |
| Comments |
| Property | Value |
| Name | TagNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Tag number |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 27465192 |
| Comments |
| Property | Value |
| Name | TypeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Type |
| Foreign field | TypeId |
| Relationship type | Foreign Key |
| Relationship name | fk Type. to Component. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | T-2615 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Component",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Counter": {
"type": "integer",
"description": "Counter of component",
"minimum": 1,
"maximum": 99999
},
"ConditionStatus": {
"type": "string",
"description": "Condition of component",
"enum": [
"Defect",
"Good",
"Not Available"
],
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DurationLifeYear": {
"type": "integer",
"description": "Life span of component in years",
"minimum": 1,
"maximum": 99
},
"WarrantyGuarantor": {
"type": "string",
"description": "Warranty Guarantor ",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"WarrantyStartDate": {
"type": "string",
"description": "Warranty start date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"SerialNumber": {
"type": "string",
"description": "Serial number of component",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TagNumber": {
"type": "string",
"description": "Tag number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TypeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"ConditionStatus",
"DurationLifeYear",
"WarrantyGuarantor",
"WarrantyStartDate",
"SerialNumber",
"TypeId"
]
}{
"ComponentId": "C-01",
"Counter": 21301,
"ConditionStatus": "Good",
"DurationLifeYear": 10,
"WarrantyGuarantor": "Apple",
"WarrantyStartDate": "2021-05-28 11:21:21",
"SerialNumber": "xan51425612",
"TagNumber": "27465192",
"TypeId": "T-2615"
}| Property | Value |
| Document name | ComponentBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to ComponentBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentBuilding",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"BuildingId"
]
}{
"ComponentId": "C-01",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | ComponentFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | fk Floor. to ComponentFloor. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentFloor",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"FloorId"
]
}{
"ComponentId": "C-01",
"FloorId": "SE-CH-F-01"
}| Property | Value |
| Document name | ComponentSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to ComponentFloor(2). |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSite",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SiteId"
]
}{
"ComponentId": "C-01",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | ComponentSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | fk Space. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSpace",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SpaceId"
]
}{
"ComponentId": "C-01",
"SpaceId": "SE-CH-F-01-21"
}| Property | Value |
| Document name | ComponentSystem |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SystemId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | System |
| Foreign field | SystemId |
| Relationship type | |
| Relationship name | fk System. to ComponentSystem. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | S-17281 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSystem",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SystemId"
]
}{
"ComponentId": "C-01",
"SystemId": "S-17281"
}| Property | Value |
| Document name | ComponentUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to ComponentUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentUnit",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"UnitId"
]
}{
"ComponentId": "C-01",
"UnitId": "UN-SE-CH-2341-02"
}| Property | Value |
| Document name | Floor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | dk | Customer ID from previous system (ID before onboarding data to BM) | |
| Name | string | true | Name of floor | ||
| FloorCode | string | false | User specific Floor Code | ||
| FloorNumber | integer | true | Number of floor | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| BuildingId | string | true | fk | Reference to the Building which the Floor belongs to |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of floor |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | EG |
| Comments |
| Property | Value |
| Name | FloorCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Floor Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | F003 |
| Comments |
| Property | Value |
| Name | FloorNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Number of floor |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -300 |
| Excl min | |
| Max value | 300 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 121 |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-01-03 11:56:34 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2045-03-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | BuildingId |
| Technical name | Bldngd |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Building which the Floor belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(2) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Floor",
"additionalProperties": false,
"properties": {
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of floor",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorCode": {
"type": "string",
"description": "User specific Floor Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorNumber": {
"type": "integer",
"description": "Number of floor",
"minimum": -300,
"maximum": 300
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"Bldngd": {
"type": "string",
"description": "Reference to the Building which the Floor belongs to",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"FloorId",
"Name",
"FloorNumber",
"ValidFrom",
"ValidUntil",
"Bldngd"
]
}{
"FloorId": "SE-CH-F-01",
"Name": "EG",
"FloorCode": "F003",
"FloorNumber": 121,
"ValidFrom": "2023-01-03 11:56:34",
"ValidUntil": "2045-03-21 00:00:00",
"Bldngd": "SE-CH-2341"
}| Property | Value |
| Document name | FloorAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | New Relationship(8) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(8) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-231231 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "FloorAreaMeasurement",
"properties": {
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"FloorId",
"AreaMeasurementId"
]
}{
"FloorId": "SE-CH-F-01",
"AreaMeasurementId": "AM-CH-SE-231231"
}| Property | Value |
| Document name | FloorUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | New Relationship(15) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(15) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-F-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "FloorUnit",
"properties": {
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"FloorId",
"UnitId"
]
}{
"FloorId": "SE-CH-F-01",
"UnitId": "UN-SE-CH-F-01"
}| Property | Value |
| Document name | Land |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| Name | string | true | Name of Land e.g: park, garden, parking | ||
| LandCode | string | false | User specific Land Code | ||
| Type | string | true | Type of land | ||
| LandCover | string | true | Development level of land | ||
| LandParcelNr | string | false | District/Zoning number registered for the Plot of land | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SiteId | string | true | fk | Reference to the site which the land belongs to | |
| ServitudeId | string | false | fk | Reference to the Servitude which belongs to the land | |
| GeorefId | string | false | A reference to Guid from the geo-coordinate entity | does not exist yet |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Land e.g: park, garden, parking |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Parking Main Building |
| Comments |
| Property | Value |
| Name | LandCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Land Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | LE3021 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of land |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | agricultural,recreational,industrial,non-industrial,traffic |
| Sample | industrial |
| Comments |
| Property | Value |
| Name | LandCover |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Development level of land |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 30 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | full,partial,non |
| Sample | partial |
| Comments |
| Property | Value |
| Name | LandParcelNr |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | District/Zoning number registered for the Plot of land |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 00087/000 |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-21 16:27:12 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2030-03-12 07:26:56 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | SiteId |
| Technical name | Std |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the site which the land belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(1) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
| Property | Value |
| Name | ServitudeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Servitude which belongs to the land |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | Servitudes |
| Foreign field | ServitudeId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(1) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-DE-05 |
| Comments |
| Property | Value |
| Name | GeorefId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | A reference to Guid from the geo-coordinate entity |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | GR-02-01 |
| Comments | does not exist yet |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Land",
"additionalProperties": false,
"properties": {
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Land e.g: park, garden, parking",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandCode": {
"type": "string",
"description": "User specific Land Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of land",
"enum": [
"agricultural",
"recreational",
"industrial",
"non-industrial",
"traffic"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandCover": {
"type": "string",
"description": "Development level of land",
"enum": [
"full",
"partial",
"non"
],
"minLength": 1,
"maxLength": 30,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandParcelNr": {
"type": "string",
"description": "District/Zoning number registered for the Plot of land",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"Std": {
"type": "string",
"description": "Reference to the site which the land belongs to",
"maxLength": 40,
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ServitudeId": {
"type": "string",
"description": "Reference to the Servitude which belongs to the land",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"GeorefId": {
"type": "string",
"description": "A reference to Guid from the geo-coordinate entity",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"Name",
"Type",
"LandCover",
"ValidFrom",
"ValidUntil",
"Std"
]
}{
"LandId": "RE-AT-05",
"Name": "Parking Main Building",
"LandCode": "LE3021",
"Type": "industrial",
"LandCover": "partial",
"LandParcelNr": "00087/000",
"ValidFrom": "2021-04-21 16:27:12",
"ValidUntil": "2030-03-12 07:26:56",
"Std": "AE-DE-02",
"ServitudeId": "SE-DE-05",
"GeorefId": "GR-02-01"
}| Property | Value |
| Document name | LandAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | New Relationship(11) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(11) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-052 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "LandAreaMeasurement",
"properties": {
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"AreaMeasurementId"
]
}{
"LandId": "RE-AT-05",
"AreaMeasurementId": "RE-AT-052"
}| Property | Value |
| Document name | LandUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | New Relationship(13) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(13) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-RE-AT-05 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "LandUnit",
"properties": {
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"UnitId"
]
}{
"LandId": "RE-AT-05",
"UnitId": "UN-RE-AT-05"
}| Property | Value |
| Document name | Servitudes |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ServitudeId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of servitude | ||
| ValidFrom | date-time | true | Date servitude starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date servitude ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ServitudeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-DE-05 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of servitude |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Easements,Covenants,Profits |
| Sample | Easements |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date servitude starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2014-02-12 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date servitude ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2034-02-12 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Servitudes",
"additionalProperties": false,
"properties": {
"ServitudeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of servitude ",
"enum": [
"Easements",
"Covenants",
"Profits"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date servitude starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date servitude ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
}
},
"required": [
"ServitudeId",
"Type",
"ValidFrom",
"ValidUntil"
]
}{
"ServitudeId": "SE-DE-05",
"Type": "Easements",
"ValidFrom": "2014-02-12 00:00:00",
"ValidUntil": "2034-02-12 00:00:00"
}| Property | Value |
| Document name | Site |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of Site | ||
| SiteCode | string | false | User specific Site Code | ||
| Type | string | true | Type of site | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Site |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Siemensstadt |
| Comments |
| Property | Value |
| Name | SiteCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Site Code |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SB001 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of site |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Education,Health Care,Hotel,Industrial,Lodging, Leisure & Recreation,Mixed use,Office,Residential,Retail,Technology/Science,Other |
| Sample | Office |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-21 12:31:13 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-08-06 16:04:45 |
| Comments | [{"dataType":"dateTime"}] |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Site",
"additionalProperties": false,
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Site",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteCode": {
"type": "string",
"description": "User specific Site Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of site",
"enum": [
"Education",
"Health Care",
"Hotel",
"Industrial",
"Lodging, Leisure & Recreation",
"Mixed use",
"Office",
"Residential",
"Retail",
"Technology/Science",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
}
},
"required": [
"SiteId",
"Name",
"Type",
"ValidFrom",
"ValidUntil"
]
}{
"SiteId": "AE-DE-02",
"Name": "Siemensstadt",
"SiteCode": "SB001",
"Type": "Office",
"ValidFrom": "2021-04-21 12:31:13",
"ValidUntil": "2023-08-06 16:04:45"
}| Property | Value |
| Document name | SiteAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | New Relationship(10) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(10) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SiteAreaMeasurement",
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SiteId",
"AreaMeasurementId"
]
}{
"SiteId": "AE-DE-02",
"AreaMeasurementId": "AM-CH-SE-2312"
}| Property | Value |
| Document name | SiteUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | New Relationship(7) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(7) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SiteUnit",
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SiteId",
"UnitId"
]
}{
"SiteId": "AE-DE-02",
"UnitId": "UN-SE-CH-2341-02"
}| Property | Value |
| Document name | Space |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Name | string | true | Name of space | ||
| SpaceCode | string | false | User specific Space Code | ||
| SpaceNumber | number | false | Number of space | [{"dataType":"float"}] | |
| Type | string | true | Type of space | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SpaceHeightUsable | number | false | Usable Height of space | [{"dataType":"float"}] | |
| SpaceHeight | number | false | Actual space height e.g: 3.6 sqm | [{"dataType":"float"}] | |
| SpaceVolumeGross | number | false | Gross volume of space including surrounding walls | [{"dataType":"float"}] | |
| SpaceVolumeNet | number | false | Gross volume of space excluding surrounding walls | [{"dataType":"float"}] | |
| PrimaryFloorMaterial | string | false | Material of floor | ||
| PrimaryWallMaterial | string | false | Material of wall | ||
| PrimaryCeilingMaterial | string | false | Material of ceiling e.g: cement | ||
| Rentability | boolean | true | Status of the space is eligible for renting out (Y/N) | ||
| EffectZonesHeating | number | false | Area that is heated | [{"dataType":"float"}] | |
| EffectZonesCooling | number | false | Area that is cooled | [{"dataType":"float"}] | |
| EffectZonesVentilation | number | false | Area that is ventilated | [{"dataType":"float"}] | |
| ClimateHeated | boolean | false | Define if space is climate heated (Y/N) | ||
| ClimateCooled | boolean | false | Define if space is climate cooled (Y/N) | ||
| CoUseArea | boolean | true | Is the space used by multiple tenants (Y/N) | ||
| MaximumOccupancy | integer | false | Define maximum occupancy of space | ||
| VentilationType | string | false | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery | ||
| FloorId | string | true | fk | Reference to the floor which the space belongs to |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of space |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Meeting room 3c |
| Comments |
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
| Property | Value |
| Name | SpaceCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Space Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | MR003 |
| Comments |
| Property | Value |
| Name | SpaceNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Number of space |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | true |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 3.2 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of space |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Residential,Office,Industrial,Retail,Storage,Parking space,Shaft,Staircase,Other |
| Sample | Office |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2014-03-02 12:21:13 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2024-03-01 12:21:23 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | SpaceHeightUsable |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Usable Height of space |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | meter (m) |
| Min value | 2 |
| Excl min | |
| Max value | 999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2.3 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | SpaceHeight |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Actual space height e.g: 3.6 sqm |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | meter (m) |
| Min value | 2 |
| Excl min | |
| Max value | 999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2.11 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | SpaceVolumeGross |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Gross volume of space including surrounding walls |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Cubic meter (m³) |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1083.27 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | SpaceVolumeNet |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Gross volume of space excluding surrounding walls |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Cubic meter (m³) |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1200.21 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | PrimaryFloorMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of floor |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Timber,Laminate,Vinyl,Bamboo,Cork,Tile (porcelain or ceramic),Tile (natural stone),Carpet,Rubber,Poured floors (mastic asphalt and polymeric) |
| Sample | Timber |
| Comments |
| Property | Value |
| Name | PrimaryWallMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of wall |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Timber,Paint,Tiles,Glass,Brick,Metal,Vinyl,Stone,Concrete,Ceramic Tiles,Plastic |
| Sample | Concrete |
| Comments |
| Property | Value |
| Name | PrimaryCeilingMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of ceiling e.g: cement |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Timber,Glypsum,Vinyl,Fibre-cement |
| Sample | Timber |
| Comments |
| Property | Value |
| Name | Rentability |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Status of the space is eligible for renting out (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | EffectZonesHeating |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Area that is heated |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Square meter (m²) |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1231.16 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | EffectZonesCooling |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Area that is cooled |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Square meter (m²) |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 40.55 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | EffectZonesVentilation |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Area that is ventilated |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Square meter (m²) |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 122.98 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | ClimateHeated |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Define if space is climate heated (Y/N) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | ClimateCooled |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Define if space is climate cooled (Y/N) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | CoUseArea |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the space used by multiple tenants (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | MaximumOccupancy |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Define maximum occupancy of space |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 10 |
| Comments |
| Property | Value |
| Name | VentilationType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | Exhaust,Supply,Balanced,Heat-recovery |
| Sample | Exhaust |
| Comments |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the floor which the space belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(3) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Space",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of space",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceCode": {
"type": "string",
"description": "User specific Space Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceNumber": {
"type": "number",
"description": "Number of space",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 99999
},
"Type": {
"type": "string",
"description": "Type of space",
"enum": [
"Residential",
"Office",
"Industrial",
"Retail",
"Storage",
"Parking space",
"Shaft",
"Staircase",
"Other"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"SpaceHeightUsable": {
"type": "number",
"description": "Usable Height of space",
"minimum": 2,
"maximum": 999
},
"SpaceHeight": {
"type": "number",
"description": "Actual space height e.g: 3.6 sqm",
"minimum": 2,
"maximum": 999
},
"SpaceVolumeGross": {
"type": "number",
"description": "Gross volume of space including surrounding walls",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"SpaceVolumeNet": {
"type": "number",
"description": "Gross volume of space excluding surrounding walls",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"PrimaryFloorMaterial": {
"type": "string",
"description": "Material of floor",
"enum": [
"Timber",
"Laminate",
"Vinyl",
"Bamboo",
"Cork",
"Tile (porcelain or ceramic)",
"Tile (natural stone)",
"Carpet",
"Rubber",
"Poured floors (mastic asphalt and polymeric)"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryWallMaterial": {
"type": "string",
"description": "Material of wall",
"enum": [
"Timber",
"Paint",
"Tiles",
"Glass",
"Brick",
"Metal",
"Vinyl",
"Stone",
"Concrete",
"Ceramic Tiles",
"Plastic"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryCeilingMaterial": {
"type": "string",
"description": "Material of ceiling e.g: cement",
"enum": [
"Timber",
"Glypsum",
"Vinyl",
"Fibre-cement"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"Rentability": {
"type": "boolean",
"description": "Status of the space is eligible for renting out (Y/N)"
},
"EffectZonesHeating": {
"type": "number",
"description": "Area that is heated",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"EffectZonesCooling": {
"type": "number",
"description": "Area that is cooled",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"EffectZonesVentilation": {
"type": "number",
"description": "Area that is ventilated",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"ClimateHeated": {
"type": "boolean",
"description": "Define if space is climate heated (Y/N)"
},
"ClimateCooled": {
"type": "boolean",
"description": "Define if space is climate cooled (Y/N)"
},
"CoUseArea": {
"type": "boolean",
"description": "Is the space used by multiple tenants (Y/N)"
},
"MaximumOccupancy": {
"type": "integer",
"description": "Define maximum occupancy of space",
"minimum": 1,
"maximum": 99999
},
"VentilationType": {
"type": "string",
"description": "Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery",
"enum": [
"Exhaust",
"Supply",
"Balanced",
"Heat-recovery"
]
},
"FloorId": {
"type": "string",
"description": "Reference to the floor which the space belongs to",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"Name",
"SpaceId",
"Type",
"ValidFrom",
"ValidUntil",
"Rentability",
"CoUseArea",
"FloorId"
]
}{
"Name": "Meeting room 3c",
"SpaceId": "SE-CH-F-01-21",
"SpaceCode": "MR003",
"SpaceNumber": 3.2,
"Type": "Office",
"ValidFrom": "2014-03-02 12:21:13",
"ValidUntil": "2024-03-01 12:21:23",
"SpaceHeightUsable": 2.3,
"SpaceHeight": 2.11,
"SpaceVolumeGross": 1083.27,
"SpaceVolumeNet": 1200.21,
"PrimaryFloorMaterial": "Timber",
"PrimaryWallMaterial": "Concrete",
"PrimaryCeilingMaterial": "Timber",
"Rentability": true,
"EffectZonesHeating": 1231.16,
"EffectZonesCooling": 40.55,
"EffectZonesVentilation": 122.98,
"ClimateHeated": true,
"ClimateCooled": true,
"CoUseArea": true,
"MaximumOccupancy": 10,
"VentilationType": "Exhaust",
"FloorId": "SE-CH-F-01"
}| Property | Value |
| Document name | SpaceAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | New Relationship(9) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(9) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312312 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SpaceAreaMeasurement",
"properties": {
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SpaceId",
"AreaMeasurementId"
]
}{
"SpaceId": "SE-CH-F-01-21",
"AreaMeasurementId": "AM-CH-SE-2312312"
}| Property | Value |
| Document name | SpaceUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | New Relationship(16) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(16) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SpaceUnit",
"properties": {
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SpaceId",
"UnitId"
]
}{
"SpaceId": "SE-CH-F-01-21",
"UnitId": "UN-SE-CH-2341-02"
}| Property | Value |
| Document name | System |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SystemId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of system | ||
| Class | string | true | Class system belongs to | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes | |
| Counter | integer | true | Counter of system | ||
| WarrantyGuarantor | string | true | Warranty Guarantor | ||
| WarrantyStartDate | date-time | true | Warranty start date in yyyy-mm-dd form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | S-17281 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of system |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Assembly system |
| Comments |
| Property | Value |
| Name | Class |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Class system belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | A |
| Comments | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes |
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Counter of system |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 12 |
| Comments |
| Property | Value |
| Name | WarrantyGuarantor |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty Guarantor |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Apple |
| Comments |
| Property | Value |
| Name | WarrantyStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty start date in yyyy-mm-dd form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-28 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "System",
"properties": {
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of system",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Class": {
"type": "string",
"description": "Class system belongs to"
},
"Counter": {
"type": "integer",
"description": "Counter of system",
"minimum": 0,
"maximum": 999999
},
"WarrantyGuarantor": {
"type": "string",
"description": "Warranty Guarantor ",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"WarrantyStartDate": {
"type": "string",
"description": "Warranty start date in yyyy-mm-dd form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
}
},
"required": [
"SystemId",
"Name",
"Class",
"Counter",
"WarrantyGuarantor",
"WarrantyStartDate"
]
}{
"SystemId": "S-17281",
"Name": "Assembly system",
"Class": "A",
"Counter": 12,
"WarrantyGuarantor": "Apple",
"WarrantyStartDate": "2021-05-28 00:00:00"
}| Property | Value |
| Document name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| TypeId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of product | ||
| Class | string | true | Class component belongs to | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes | |
| Counter | integer | true | Counter of type | ||
| Manufacturer | string | true | Name of manufacturer | ||
| ManufacturerCode | string | false | Manufacturer code | ||
| ExpectedLifeYear | integer | false | Life span of product in years | [{"dataType":"integer16"}] | |
| MaintenanceGroup | string | false | Maintenance group | ||
| MaintenanceRelevance | string | false | Relevance of maintenance | ||
| URLLibrary | string | false | Product website | ||
| CE-Identification | string | false | European identification number |
| Property | Value |
| Name | TypeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | T-2615 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of product |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Door |
| Comments |
| Property | Value |
| Name | Class |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Class component belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Door |
| Comments | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes |
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Counter of type |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 12 |
| Comments |
| Property | Value |
| Name | Manufacturer |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of manufacturer |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Bosch |
| Comments |
| Property | Value |
| Name | ManufacturerCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Manufacturer code |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B6274519 |
| Comments |
| Property | Value |
| Name | ExpectedLifeYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Life span of product in years |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | years |
| Min value | 1 |
| Excl min | |
| Max value | 99 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 10 |
| Comments | [{"dataType":"integer16"}] |
| Property | Value |
| Name | MaintenanceGroup |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Maintenance group |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | MaintenanceRelevance |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Relevance of maintenance |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | High,Medium,Low |
| Sample | High |
| Comments |
| Property | Value |
| Name | URLLibrary |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Product website |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | www.siemens-home.bsh-group.com/de/produkte/kuehlschraenke-gefrierschraenke |
| Comments |
| Property | Value |
| Name | CE-Identification |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | European identification number |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE 0123 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Type",
"properties": {
"TypeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of product",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Class": {
"type": "string",
"description": "Class component belongs to",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Counter": {
"type": "integer",
"description": "Counter of type",
"minimum": 0,
"maximum": 999999
},
"Manufacturer": {
"type": "string",
"description": "Name of manufacturer",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ManufacturerCode": {
"type": "string",
"description": "Manufacturer code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ExpectedLifeYear": {
"type": "integer",
"description": "Life span of product in years",
"minimum": 1,
"maximum": 99
},
"MaintenanceGroup": {
"type": "string",
"description": "Maintenance group",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"MaintenanceRelevance": {
"type": "string",
"description": "Relevance of maintenance",
"enum": [
"High",
"Medium",
"Low"
],
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"URLLibrary": {
"type": "string",
"description": "Product website",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CE-Identification": {
"type": "string",
"description": "European identification number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TypeId",
"Name",
"Class",
"Counter",
"Manufacturer"
]
}{
"TypeId": "T-2615",
"Name": "Door",
"Class": "Door",
"Counter": 12,
"Manufacturer": "Bosch",
"ManufacturerCode": "B6274519",
"ExpectedLifeYear": 10,
"MaintenanceGroup": "Lorem",
"MaintenanceRelevance": "High",
"URLLibrary": "www.siemens-home.bsh-group.com/de/produkte/kuehlschraenke-gefrierschraenke",
"CE-Identification": "CE 0123"
}| Property | Value |
| Document name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of Unit e.g: part of building, rental unit | ||
| Name | string | true | Name of unit | ||
| Code | string | false | User-specific code for unit | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Unit e.g: part of building, rental unit |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | East Wing |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of unit |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | East Wing |
| Comments |
| Property | Value |
| Name | Code |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User-specific code for unit |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C602 |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-05-07 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2027-09-19 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Unit",
"additionalProperties": false,
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Unit e.g: part of building, rental unit",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of unit",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Code": {
"type": "string",
"description": "User-specific code for unit",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00"
}
},
"required": [
"UnitId",
"Type",
"Name",
"ValidFrom",
"ValidUntil"
]
}{
"UnitId": "UN-SE-CH-2341-02",
"Type": "East Wing",
"Name": "East Wing",
"Code": "C602",
"ValidFrom": "2022-05-07 00:00:00",
"ValidUntil": "2027-09-19 00:00:00"
}| Property | Value |
| Document name | UnitAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(12) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(12) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Am-UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitAreaMeasurement",
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"UnitId",
"AreaMeasurementId"
]
}{
"UnitId": "UN-SE-CH-2341-02",
"AreaMeasurementId": "Am-UN-SE-CH-2341-02"
}| Property | Value |
| Group name | EnergyAndResources |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
| Property | Value |
| Document name | Climate |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ClimateGuid | string | true | Globally Unique Identifier number | ||
| Experiment | string | false | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 | ||
| TemporalResolution | string | false | Temporal resolution of data (can be the time period over which raw data is aggregated) | ||
| SpatialResolution | string | false | Spatial resolution of data | ||
| GCM | string | false | Global climate model used | ||
| RCM | string | false | Regional climate model used | ||
| SimV | string | false | Run number of certain climate model or model combination | ||
| EnsM | string | false | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' | ||
| Value | number | true | Value of observed variable | [{"dataType":"float"}] | |
| Unit | string | true | Unit of observed value | ||
| ValidFrom | date-time | true | Date observation starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date observation ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| LocationType | string | true | Type of spatial reference e.g. Zip code or geographic coordinates | ||
| CoordinateSystem | string | false | Specific coordinate system used | ||
| Location | string | false | Localisation of observed data in case of non-grid location types | ||
| Lat | integer | false | Latitude coordinate in case of geographic coordinates | ||
| Lon | integer | false | Longitude coordinate in case of geographic coordinates | ||
| PosX | integer | false | |||
| PosY | integer | false | Vertical coordinate in case of projected coordinates | ||
| Variable | string | true | Observed variable |
| Property | Value |
| Name | Experiment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Historical |
| Comments |
| Property | Value |
| Name | TemporalResolution |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Temporal resolution of data (can be the time period over which raw data is aggregated) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | monthly |
| Comments |
| Property | Value |
| Name | SpatialResolution |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Spatial resolution of data |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 0.11 degree x 0.11 degree |
| Comments |
| Property | Value |
| Name | GCM |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Global climate model used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | MPI-M-MPI-ESM-LR |
| Comments |
| Property | Value |
| Name | RCM |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Regional climate model used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AWI-HIRHAM5 |
| Comments |
| Property | Value |
| Name | SimV |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Run number of certain climate model or model combination |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | EnsM |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | r1i1p1 |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of observed variable |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 28462827.85 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of observed value |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Celsius |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date observation starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-08-16 12:02:13 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date observation ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-08-19 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | LocationType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of spatial reference e.g. Zip code or geographic coordinates |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | NUTS3,Zip Code,Geographic coordinates,Projected coordinates |
| Sample | Geographic coordinates |
| Comments |
| Property | Value |
| Name | CoordinateSystem |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific coordinate system used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Location |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Localisation of observed data in case of non-grid location types |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DE27C |
| Comments |
| Property | Value |
| Name | Lat |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Latitude coordinate in case of geographic coordinates |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Lon |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Longitude coordinate in case of geographic coordinates |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | PosX |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | PosY |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Vertical coordinate in case of projected coordinates |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Variable |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Observed variable |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | HDD |
| Comments |
| Property | Value |
| Name | ClimateGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 075a2983-a8e5-4ea8-a354-6a88b311bfdb |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Climate",
"properties": {
"Experiment": {
"type": "string",
"description": "Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TemporalResolution": {
"type": "string",
"description": "Temporal resolution of data (can be the time period over which raw data is aggregated)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpatialResolution": {
"type": "string",
"description": "Spatial resolution of data",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"GCM": {
"type": "string",
"description": "Global climate model used",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RCM": {
"type": "string",
"description": "Regional climate model used",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SimV": {
"type": "string",
"description": "Run number of certain climate model or model combination",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnsM": {
"type": "string",
"description": "Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of observed variable",
"minimum": 1,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of observed value",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date observation starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date observation ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"LocationType": {
"type": "string",
"description": "Type of spatial reference e.g. Zip code or geographic coordinates",
"minLength": 1,
"enum": [
"NUTS3",
"Zip Code",
"Geographic coordinates",
"Projected coordinates"
],
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CoordinateSystem": {
"type": "string",
"description": "Specific coordinate system used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Location": {
"type": "string",
"description": "Localisation of observed data in case of non-grid location types",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Lat": {
"type": "integer",
"description": "Latitude coordinate in case of geographic coordinates"
},
"Lon": {
"type": "integer",
"description": "Longitude coordinate in case of geographic coordinates"
},
"PosX": {
"type": "integer"
},
"PosY": {
"type": "integer",
"description": "Vertical coordinate in case of projected coordinates"
},
"Variable": {
"type": "string",
"description": "Observed variable",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ClimateGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"Value",
"Unit",
"ValidFrom",
"ValidUntil",
"LocationType",
"Variable",
"ClimateGuid"
]
}{
"Experiment": "Historical",
"TemporalResolution": "monthly",
"SpatialResolution": "0.11 degree x 0.11 degree",
"GCM": "MPI-M-MPI-ESM-LR",
"RCM": "AWI-HIRHAM5",
"SimV": "Lorem",
"EnsM": "r1i1p1",
"Value": 28462827.85,
"Unit": "Celsius",
"ValidFrom": "2021-08-16 12:02:13",
"ValidUntil": "2022-08-19 00:00:00",
"LocationType": "Geographic coordinates",
"CoordinateSystem": "Lorem",
"Location": "DE27C",
"Lat": -63,
"Lon": 28,
"PosX": -46,
"PosY": 41,
"Variable": "HDD",
"ClimateGuid": "075a2983-a8e5-4ea8-a354-6a88b311bfdb"
}| Property | Value |
| Document name | ClimateBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ClimateGuid | string | true | Climate Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | ClimateGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Climate Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Climate |
| Foreign field | ClimateGuid |
| Relationship type | |
| Relationship name | New Relationship(32) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to ClimateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ClimateBuilding",
"properties": {
"ClimateGuid": {
"type": "string",
"description": "Climate Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateGuid",
"BuildingId"
]
}{
"ClimateGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | ClimateSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ClimateGuid | string | true | Climate Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | ClimateGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Climate Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Climate |
| Foreign field | ClimateGuid |
| Relationship type | |
| Relationship name | New Relationship(31) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to ClimateSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ClimateSite",
"properties": {
"ClimateGuid": {
"type": "string",
"description": "Climate Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateGuid",
"SiteId"
]
}{
"ClimateGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | EmissionFactor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Globally Unique Identifier number | ||
| Country | string | true | Country in which the emission factor is valid | ||
| Type | string | true | Type of resource consumption the emission factor refers to | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Value | number | true | Value of emission factor | [{"dataType":"float"}] | |
| Unit | string | false | Unit of emission factor in terms of kgCO2e per unit of resource consumption | ||
| Source | string | false | Source of emission factor e.g. 'International Energy Agency' | ||
| SpaceType | string | false | Differentiated emission factor for certain space type (within a building) | ||
| Region | string | false | |||
| City | string | false | |||
| Scenario | string | false | User specific emission factor scenario | ||
| OperationalMeasurementGuid | string | false | fk | Differentiated emission factor for certain operational measurement |
| Property | Value |
| Name | Country |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Country in which the emission factor is valid |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Germany |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of resource consumption the emission factor refers to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Natural gas (standard mix),Oil-based fuels,District heating,Water discharge,Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply |
| Sample | District heating |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-02-12 07:03:33 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-03-21 11:25:21 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of emission factor |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2638593.12 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of emission factor in terms of kgCO2e per unit of resource consumption |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kgCO2e/kWh,kgCO2e/kg,kgCO2e/m3 |
| Sample | kgCO2e/kg |
| Comments |
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Source of emission factor e.g. 'International Energy Agency' |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | International Energy Agency |
| Comments |
| Property | Value |
| Name | SpaceType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Differentiated emission factor for certain space type (within a building) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Shared services/Common spaces,Tenant space,Landlord space,Whole building,Unspecified,Shared services,Common spaces |
| Sample | Landlord space |
| Comments |
| Property | Value |
| Name | Region |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Bavaria |
| Comments |
| Property | Value |
| Name | City |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Berlin |
| Comments |
| Property | Value |
| Name | Scenario |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific emission factor scenario |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM default |
| Comments |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Differentiated emission factor for certain operational measurement |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(18) |
| Cardinality | 1..n |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactor",
"additionalProperties": false,
"properties": {
"Country": {
"type": "string",
"description": "Country in which the emission factor is valid",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of resource consumption the emission factor refers to",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Natural gas (standard mix)",
"Oil-based fuels",
"District heating",
"Water discharge",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of emission factor",
"minimum": -100000000000000000,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of emission factor in terms of kgCO2e per unit of resource consumption",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kgCO2e/kWh",
"kgCO2e/kg",
"kgCO2e/m3"
]
},
"Source": {
"type": "string",
"description": "Source of emission factor e.g. 'International Energy Agency'",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceType": {
"type": "string",
"description": "Differentiated emission factor for certain space type (within a building)",
"enum": [
"Shared services/Common spaces",
"Tenant space",
"Landlord space",
"Whole building",
"Unspecified",
"Shared services",
"Common spaces"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Region": {
"type": "string",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"City": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Scenario": {
"type": "string",
"description": "User specific emission factor scenario",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Differentiated emission factor for certain operational measurement",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"EmissionFactorGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"Country",
"Type",
"ValidFrom",
"ValidUntil",
"Value",
"EmissionFactorGuid"
]
}{
"Country": "Germany",
"Type": "District heating",
"ValidFrom": "2021-02-12 07:03:33",
"ValidUntil": "2022-03-21 11:25:21",
"Value": 2638593.12,
"Unit": "kgCO2e/kg",
"Source": "International Energy Agency",
"SpaceType": "Landlord space",
"Region": "Bavaria",
"City": "Berlin",
"Scenario": "BM default",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e"
}| Property | Value |
| Document name | EmissionFactorBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Emission Factor Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission Factor Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorGuid |
| Relationship type | |
| Relationship name | New Relationship(22) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to EmissionFactorBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorBuilding",
"properties": {
"EmissionFactorGuid": {
"type": "string",
"description": "Emission Factor Globally Unique Identifier number",
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$",
"minLength": 1,
"maxLength": 40
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorGuid",
"SiteId"
]
}{
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | EmissionFactorBusinessPartner |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Globally Unique Identifier number | ||
| RoleId | string | true | Link to role |
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorGuid |
| Relationship type | |
| Relationship name | New Relationship(33) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to role |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OperationalMeasurement. |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorBusinessPartner",
"properties": {
"EmissionFactorGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"RoleId": {
"type": "string",
"description": "Link to role",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorGuid",
"RoleId"
]
}{
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e",
"RoleId": "R-01"
}| Property | Value |
| Document name | EmissionFactorSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Emission Factor Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission Factor Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorGuid |
| Relationship type | |
| Relationship name | New Relationship(21) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to EmissionFactorSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorSite",
"properties": {
"EmissionFactorGuid": {
"type": "string",
"description": "Emission Factor Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorGuid",
"BuildingId"
]
}{
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | GhgEmissions |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionsGuid | string | true | Globally Unique Identifier number | ||
| Name | string | false | Name of individual emission value (user-provided) | ||
| Parent | string | false | Parent (Guid) of individual emission value | ||
| EmissionScope | string | true | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol | ||
| ReportingType | string | true | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
| Type | string | true | General source of emission e.g. energy, water or waste | ||
| SubType | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| LCA | string | false | Related life cycle assessment stage according to ISO 14040 | ||
| ProjectionBaseYear | date-time | false | Base year of emissions projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Value | number | false | Value of individual emission | [{"dataType":"float"}] | |
| Unit | string | false | Unit of emission value: kgCO2e | ||
| EmissionFactorScenario | string | false | User specific Emission Factor Scenario (BM default can be used) | ||
| Accuracy | string | true | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
| OperationalMeasurementGuid | string | false | fk | Identifier of related operational measurement |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of individual emission value (user-provided) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Biom¸ll |
| Comments |
| Property | Value |
| Name | Parent |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Parent (Guid) of individual emission value |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ef3f9faf-48c5-4609-ae0a-43340d9369c4 |
| Comments |
| Property | Value |
| Name | EmissionScope |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | 1,2,3,Unspecified |
| Sample | 2 |
| Comments |
| Property | Value |
| Name | ReportingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Location-based,Market-based,NA |
| Sample | Market-based |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | General source of emission e.g. energy, water or waste |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Energy,Fugitive,Waste,Water discharge,Water supply |
| Sample | Waste |
| Comments |
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & exported,Electricity self-generated & consumed,Electricity (unspecified),REC,Natural gas (standard mix),Green natural gas,Natural gas (unspecified),Oil-based fuels,Fuel (unspecified),District heating,District Cooling,Biomass,Solar thermal,Fresh water (municipal water supply),Ground water (collected on site),Rain water (collected on site),Reclaimed water,Water discharge,Water consumption (unspecified),Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply,Non-hazardous waste |
| Sample | Solar thermal |
| Comments |
| Property | Value |
| Name | LCA |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Related life cycle assessment stage according to ISO 14040 |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | A1,A2,A3,A4,A5,B1,B2,B3,B4,B5,B6,B7,C1,C2,C3,C4,D |
| Sample | B4 |
| Comments |
| Property | Value |
| Name | ProjectionBaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of emissions projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-24 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-06 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-05-05 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of individual emission |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 354678233.32 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of emission value: kgCO2e |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kgCO2e,NA |
| Sample | kgCO2e |
| Comments |
| Property | Value |
| Name | EmissionFactorScenario |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Emission Factor Scenario (BM default can be used) |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM default |
| Comments |
| Property | Value |
| Name | Accuracy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Calculated based on estimated data,Calculated based on metered data,Calculated based on extrapolated data,Calculated based on planed data,Calculated based on simulated data,Calculated based on data with unspecified accuracy,Calculated based on projected estimated data,Calculated based on projected metered data,Calculated based on projected extrapolated data,Calculated based on projected planned data,Calculated based on projected simulated data,Calculated based on projected data with unspecified accuracy,Estimated,Metered,Extrapolated,Planned,Unspecified,Simulated,Projection based on estimated data,Projection based on metered data,Projection based on extrapolated data,Projection based on planned data,Projection based on data with unspecified accuracy,Projection based on simulated data,Missing |
| Sample | Missing |
| Comments |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of related operational measurement |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(19) |
| Cardinality | 1..n |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | GhgEmissionsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissions",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of individual emission value (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Parent": {
"type": "string",
"description": "Parent (Guid) of individual emission value",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"EmissionScope": {
"type": "string",
"description": "Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"1",
"2",
"3",
"Unspecified"
]
},
"ReportingType": {
"type": "string",
"description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Location-based",
"Market-based",
"NA"
]
},
"Type": {
"type": "string",
"description": "General source of emission e.g. energy, water or waste",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"Fugitive",
"Waste",
"Water discharge",
"Water supply"
]
},
"SubType": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & exported",
"Electricity self-generated & consumed",
"Electricity (unspecified)",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Natural gas (unspecified)",
"Oil-based fuels",
"Fuel (unspecified)",
"District heating",
"District Cooling",
"Biomass",
"Solar thermal",
"Fresh water (municipal water supply)",
"Ground water (collected on site)",
"Rain water (collected on site)",
"Reclaimed water",
"Water discharge",
"Water consumption (unspecified)",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply",
"Non-hazardous waste"
]
},
"LCA": {
"type": "string",
"description": "Related life cycle assessment stage according to ISO 14040",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"A1",
"A2",
"A3",
"A4",
"A5",
"B1",
"B2",
"B3",
"B4",
"B5",
"B6",
"B7",
"C1",
"C2",
"C3",
"C4",
"D"
]
},
"ProjectionBaseYear": {
"type": "string",
"description": "Base year of emissions projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00.",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of individual emission",
"maximum": 100000000000000000,
"minimum": -100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of emission value: kgCO2e",
"enum": [
"kgCO2e",
"NA"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EmissionFactorScenario": {
"type": "string",
"description": "User specific Emission Factor Scenario (BM default can be used)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Accuracy": {
"type": "string",
"description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 75,
"enum": [
"Calculated based on estimated data",
"Calculated based on metered data",
"Calculated based on extrapolated data",
"Calculated based on planed data",
"Calculated based on simulated data",
"Calculated based on data with unspecified accuracy",
"Calculated based on projected estimated data",
"Calculated based on projected metered data",
"Calculated based on projected extrapolated data",
"Calculated based on projected planned data",
"Calculated based on projected simulated data",
"Calculated based on projected data with unspecified accuracy",
"Estimated",
"Metered",
"Extrapolated",
"Planned",
"Unspecified",
"Simulated",
"Projection based on estimated data",
"Projection based on metered data",
"Projection based on extrapolated data",
"Projection based on planned data",
"Projection based on data with unspecified accuracy",
"Projection based on simulated data",
"Missing"
]
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Identifier of related operational measurement",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"GhgEmissionsGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"EmissionScope",
"ReportingType",
"Type",
"SubType",
"ValidFrom",
"ValidUntil",
"Accuracy",
"GhgEmissionsGuid"
]
}{
"Name": "Biom¸ll",
"Parent": "ef3f9faf-48c5-4609-ae0a-43340d9369c4",
"EmissionScope": "2",
"ReportingType": "Market-based",
"Type": "Waste",
"SubType": "Solar thermal",
"LCA": "B4",
"ProjectionBaseYear": "2021-05-24 00:00:00",
"ValidFrom": "2021-04-06 00:00:00",
"ValidUntil": "2023-05-05 00:00:00",
"Value": 354678233.32,
"Unit": "kgCO2e",
"EmissionFactorScenario": "BM default",
"Accuracy": "Missing",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"GhgEmissionsGuid": "ba4900a3-8c7c-4966-9cd3-a5889f309c40"
}| Property | Value |
| Document name | GhgEmissionsBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionsGuid | string | true | gHg Emissions Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | GhgEmissionsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | gHg Emissions Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | GhgEmissions |
| Foreign field | GhgEmissionsGuid |
| Relationship type | |
| Relationship name | New Relationship(24) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to gHgEmissionsBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionsBuilding",
"properties": {
"GhgEmissionsGuid": {
"type": "string",
"description": "gHg Emissions Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"GhgEmissionsGuid",
"BuildingId"
]
}{
"GhgEmissionsGuid": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | GhgEmissionsSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionsGuid | string | true | gHg Emissions Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | GhgEmissionsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | gHg Emissions Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | GhgEmissions |
| Foreign field | GhgEmissionsGuid |
| Relationship type | |
| Relationship name | New Relationship(23) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to gHgEmissionsSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionsSite",
"properties": {
"GhgEmissionsGuid": {
"type": "string",
"description": "gHg Emissions Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"GhgEmissionsGuid",
"SiteId"
]
}{
"GhgEmissionsGuid": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | OperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | dk | Globally Unique Identifier number | |
| Parent | string | false | Parent (Guid) of individual operational measurement | ||
| Purpose | string | true | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas | ||
| Accuracy | string | true | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
| Type | string | true | General type of operational measurement e.g. energy, water or waste | ||
| SubType | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| Name | string | false | Name of individual operational measurement. (user-provided) | ||
| Value | number | false | Value of individual operational measurement | [{"dataType":"float"}] | |
| Unit | string | false | Unit of operational measurement e.g. 'kWh' or 'm³' | ||
| ProcuredBy | string | true | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol | ||
| SpaceType | string | true | Reference to specific space type (or 'whole building') | ||
| LCA | string | false | Related life cycle assessment stage according to ISO 14040 | ||
| PostingDate | date-time | false | Date of measurement posting in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| MeasurementDate | date-time | false | Date of measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ProjectionBaseYear | date-time | false | Base year of operational value projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| ProjectionBaseGuid | string | false | Identifier (Guid) of operational value projected into the future | Identifier (Guid) of operational value projected into the future | |
| MeterNumber | string | false | Name of meter providing value (user-provided) | ||
| MeterId | string | false | Identifier of meter providing value | ||
| RoleId | string | true | fk | Link to role |
| Property | Value |
| Name | Parent |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Parent (Guid) of individual operational measurement |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | c7175705-411f-4548-90d4-f58740fc2d30 |
| Comments |
| Property | Value |
| Name | Purpose |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Space heating,Water heating,Heating (unspecified),Cooling,Lighting,Elevator,Appliances,Other,Unspecified |
| Sample | Space heating |
| Comments |
| Property | Value |
| Name | Accuracy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Estimated,Metered,Extrapolated,Planned,Simulated,Unspecified,Projection based on estimated data,Projection based on metered data,Projection based on extrapolated data,Projection based on planned data,Projection based on simulated data,Projection based on data with unspecified accuracy,Missing |
| Sample | Extrapolated |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | General type of operational measurement e.g. energy, water or waste |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Energy,Water,Waste,Fugitive |
| Sample | Waste |
| Comments |
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & exported,Electricity self-generated & consumed,Electricity (unspecified),REC,Natural gas (standard mix),Green natural gas,Natural gas (unspecified),Oil-based fuels,Fuel (unspecified),District heating,District Cooling,Biomass,Solar thermal,Fresh water (municipal water supply),Ground water (collected on site),Rain water (collected on site),Reclaimed water,Water discharge,Water consumption (unspecified),Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply,Non-hazardous waste |
| Sample | Solar thermal |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of individual operational measurement. (user-provided) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of individual operational measurement |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1234.3476 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of operational measurement e.g. 'kWh' or 'm³' |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kWh,m³,kg |
| Sample | |
| Comments |
| Property | Value |
| Name | ProcuredBy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Procured by third party,Self-procured,Unspecified,NA |
| Sample | Self-procured |
| Comments |
| Property | Value |
| Name | SpaceType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to specific space type (or 'whole building') |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Shared services/Common spaces,Tenant space,Landlord space,Whole building,Unspecified,Shared services,Common spaces |
| Sample | Landlord space |
| Comments |
| Property | Value |
| Name | LCA |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Related life cycle assessment stage according to ISO 14040 |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | A1,A2,A3,A4,A5,B1,B2,B3,B4,B5,B6,B7,C1,C2,C3,C4,D |
| Sample | B4 |
| Comments |
| Property | Value |
| Name | PostingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of measurement posting in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-29 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | MeasurementDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-30 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-07-05 13:21:21 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-06 11:47:21 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ProjectionBaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of operational value projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-09-21 21:29:56 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ProjectionBaseGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier (Guid) of operational value projected into the future |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | Identifier (Guid) of operational value projected into the future |
| Property | Value |
| Name | MeterNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of meter providing value (user-provided) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 201-Main Building |
| Comments |
| Property | Value |
| Name | MeterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of meter providing value |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to role |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to OperationalMeasurement. |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurement",
"additionalProperties": false,
"properties": {
"Parent": {
"type": "string",
"description": "Parent (Guid) of individual operational measurement",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"Purpose": {
"type": "string",
"description": "Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Space heating",
"Water heating",
"Heating (unspecified)",
"Cooling",
"Lighting",
"Elevator",
"Appliances",
"Other",
"Unspecified"
]
},
"Accuracy": {
"type": "string",
"description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 75,
"enum": [
"Estimated",
"Metered",
"Extrapolated",
"Planned",
"Simulated",
"Unspecified",
"Projection based on estimated data",
"Projection based on metered data",
"Projection based on extrapolated data",
"Projection based on planned data",
"Projection based on simulated data",
"Projection based on data with unspecified accuracy",
"Missing"
]
},
"Type": {
"type": "string",
"description": "General type of operational measurement e.g. energy, water or waste",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"Water",
"Waste",
"Fugitive"
]
},
"SubType": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & exported",
"Electricity self-generated & consumed",
"Electricity (unspecified)",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Natural gas (unspecified)",
"Oil-based fuels",
"Fuel (unspecified)",
"District heating",
"District Cooling",
"Biomass",
"Solar thermal",
"Fresh water (municipal water supply)",
"Ground water (collected on site)",
"Rain water (collected on site)",
"Reclaimed water",
"Water discharge",
"Water consumption (unspecified)",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply",
"Non-hazardous waste"
]
},
"Name": {
"type": "string",
"description": "Name of individual operational measurement. (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of individual operational measurement",
"minimum": -100000000000000000,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of operational measurement e.g. 'kWh' or 'm³'",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kWh",
"m³",
"kg"
]
},
"ProcuredBy": {
"type": "string",
"description": "Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Procured by third party",
"Self-procured",
"Unspecified",
"NA"
]
},
"SpaceType": {
"type": "string",
"description": "Reference to specific space type (or 'whole building')",
"enum": [
"Shared services/Common spaces",
"Tenant space",
"Landlord space",
"Whole building",
"Unspecified",
"Shared services",
"Common spaces"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LCA": {
"type": "string",
"description": "Related life cycle assessment stage according to ISO 14040",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"A1",
"A2",
"A3",
"A4",
"A5",
"B1",
"B2",
"B3",
"B4",
"B5",
"B6",
"B7",
"C1",
"C2",
"C3",
"C4",
"D"
]
},
"PostingDate": {
"type": "string",
"description": "Date of measurement posting in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"MeasurementDate": {
"type": "string",
"description": "Date of measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ProjectionBaseYear": {
"type": "string",
"description": "Base year of operational value projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00.",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ProjectionBaseGuid": {
"type": "string",
"description": "Identifier (Guid) of operational value projected into the future",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"MeterNumber": {
"type": "string",
"description": "Name of meter providing value (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MeterId": {
"type": "string",
"description": "Identifier of meter providing value"
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"RoleId": {
"type": "string",
"description": "Link to role",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"Purpose",
"Accuracy",
"Type",
"SubType",
"ProcuredBy",
"SpaceType",
"ValidFrom",
"ValidUntil",
"OperationalMeasurementGuid",
"RoleId"
]
}{
"Parent": "c7175705-411f-4548-90d4-f58740fc2d30",
"Purpose": "Space heating",
"Accuracy": "Extrapolated",
"Type": "Waste",
"SubType": "Solar thermal",
"Name": "Lorem",
"Value": 1234.3476,
"Unit": "kg",
"ProcuredBy": "Self-procured",
"SpaceType": "Landlord space",
"LCA": "B4",
"PostingDate": "2021-04-29 00:00:00",
"MeasurementDate": "2020-09-30 00:00:00",
"ValidFrom": "2021-07-05 13:21:21",
"ValidUntil": "2021-05-06 11:47:21",
"ProjectionBaseYear": "2023-09-21 21:29:56",
"ProjectionBaseGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"MeterNumber": "201-Main Building",
"MeterId": "Lorem",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"RoleId": "R-01"
}| Property | Value |
| Document name | OperationalMeasurementBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(27) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to OperationalMeasurementBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementBuilding",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"BuildingId"
]
}{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | OperationalMeasurementFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(28) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | fk Floor. to OperationalMeasurementFloor. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementFloor",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"FloorId"
]
}{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"FloorId": "SE-CH-F-01"
}| Property | Value |
| Document name | OperationalMeasurementLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| LandId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(26) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to OperationalMeasurementLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementLand",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"LandId"
]
}{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"LandId": "RE-AT-05"
}| Property | Value |
| Document name | OperationalMeasurementSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(25) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to OperationalMeasurementSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementSite",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"SiteId"
]
}{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | OperationalMeasurementSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| SpaceId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(29) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | fk Space. to OperationalMeasurementSpace. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementSpace",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"SpaceId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"SpaceId"
]
}{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"SpaceId": "SE-CH-F-01-21"
}| Property | Value |
| Document name | OperationalMeasurementUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(28) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to OperationalMeasurementUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementUnit",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"UnitId"
]
}{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"UnitId": "UN-SE-CH-2341-02"
}| Property | Value |
| Document name | SustainabilityIndicators |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| SustainabilityIndicatorsGuid | string | true | Globally Unique Identifier number | ||
| Category | string | true | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs | ||
| Type | string | true | Type of sustainability indicator e.g. absolute or intensity figures or stranding | ||
| Subtype | string | true | Subtype of sustainability indicator e.g. net-energy or emission scope | ||
| Source | string | true | Operational source of energy or emission figures e.g. electricity or water | ||
| ReferenceArea | string | true | Reference area of building used as denominator in intensity calculation | ||
| ReportingType | string | true | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
| BaseYear | date-time | false | Base year of values projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| Value | number | false | Value of sustainability indicator | [{"dataType":"float"}] | |
| EmissionFactorScenario | string | false | User specific emission factor scenario | ||
| Unit | string | true | Unit of sustainability indicator value | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| BuildingId | string | true | fk | Identifier of building |
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Costs,Energy,Ghg |
| Sample | Energy |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of sustainability indicator e.g. absolute or intensity figures or stranding |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Absolute,Intensity,Excess emissions,Stranding,Target |
| Sample | Excess emissions |
| Comments |
| Property | Value |
| Name | Subtype |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Subtype of sustainability indicator e.g. net-energy or emission scope |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Total,Scope 1,Scope 2,Scope 3,Unspecified scope,Net energy,Consumption,Renewable on-site,Renewable including off-site,CRREM 1.5°C,CRREM 2°C |
| Sample | Unspecified scope |
| Comments |
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational source of energy or emission figures e.g. electricity or water |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Energy,All,Fuels,Electricity,District heating,District cooling,Fugitive,Water supply,Water discharge,Water,Waste,NA |
| Sample | Electricity |
| Comments |
| Property | Value |
| Name | ReferenceArea |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference area of building used as denominator in intensity calculation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Net rentable area,Gross internal area,NA |
| Sample | Gross internal area |
| Comments |
| Property | Value |
| Name | ReportingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Location-based,Market-based,NA |
| Sample | Market-based |
| Comments |
| Property | Value |
| Name | BaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of values projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-01-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of sustainability indicator |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 546372812.24 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | EmissionFactorScenario |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific emission factor scenario |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM default |
| Comments |
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of sustainability indicator value |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kgCO2e,kgCO2e/m²,kWh,kWh/m²,€,NA,m² |
| Sample | kWh/m² |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-01 11:34:45 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-04-01 19:56:01 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of building |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to SustainabilityIndicators. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
| Property | Value |
| Name | SustainabilityIndicatorsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 8462d997-6fd2-439e-88d0-d3b2e19517c8 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SustainabilityIndicators",
"properties": {
"Category": {
"type": "string",
"description": "Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Costs",
"Energy",
"Ghg"
]
},
"Type": {
"type": "string",
"description": "Type of sustainability indicator e.g. absolute or intensity figures or stranding",
"enum": [
"Absolute",
"Intensity",
"Excess emissions",
"Stranding",
"Target"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Subtype": {
"type": "string",
"description": "Subtype of sustainability indicator e.g. net-energy or emission scope",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Total",
"Scope 1",
"Scope 2",
"Scope 3",
"Unspecified scope",
"Net energy",
"Consumption",
"Renewable on-site",
"Renewable including off-site",
"CRREM 1.5°C",
"CRREM 2°C"
]
},
"Source": {
"type": "string",
"description": "Operational source of energy or emission figures e.g. electricity or water",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"All",
"Fuels",
"Electricity",
"District heating",
"District cooling",
"Fugitive",
"Water supply",
"Water discharge",
"Water",
"Waste",
"NA"
]
},
"ReferenceArea": {
"type": "string",
"description": "Reference area of building used as denominator in intensity calculation",
"enum": [
"Net rentable area",
"Gross internal area",
"NA"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ReportingType": {
"type": "string",
"description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Location-based",
"Market-based",
"NA"
]
},
"BaseYear": {
"type": "string",
"description": "Base year of values projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00.",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of sustainability indicator",
"maximum": 100000000000000000,
"minimum": -100000000000000000
},
"EmissionFactorScenario": {
"type": "string",
"description": "User specific emission factor scenario",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Unit": {
"type": "string",
"description": "Unit of sustainability indicator value",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kgCO2e",
"kgCO2e/m²",
"kWh",
"kWh/m²",
"€",
"NA",
"m²"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time"
},
"BuildingId": {
"type": "string",
"description": "Identifier of building",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SustainabilityIndicatorsGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"Category",
"Type",
"Subtype",
"Source",
"ReferenceArea",
"ReportingType",
"Unit",
"ValidFrom",
"ValidUntil",
"BuildingId",
"SustainabilityIndicatorsGuid"
]
}{
"Category": "Energy",
"Type": "Excess emissions",
"Subtype": "Unspecified scope",
"Source": "Electricity",
"ReferenceArea": "Gross internal area",
"ReportingType": "Market-based",
"BaseYear": "2022-01-01 00:00:00",
"Value": 546372812.24,
"EmissionFactorScenario": "BM default",
"Unit": "kWh/m²",
"ValidFrom": "2021-03-01 11:34:45",
"ValidUntil": "2023-04-01 19:56:01",
"BuildingId": "SE-CH-2341",
"SustainabilityIndicatorsGuid": "8462d997-6fd2-439e-88d0-d3b2e19517c8"
}| Property | Value |
| Group name | Financials |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
| Property | Value |
| Document name | Account |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AccountId | string | true | dk | Account number | |
| Name | string | true | Account name | ||
| Project | string | true | Account Type (project aligned with RICS naming convention) | ||
| Category | string | true | Account category according to IBPDI charts of accounts (category aligned with RICS naming convention) | ||
| Group | string | true | Account group according IBPDI charts of accounts (group aligned with RICS naming convention) | ||
| ValidFrom | date-time | true | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StatementType | string | true | Statement type (Balance statement or P&L account) | ||
| RecordType | string | true | Record type (Debit or Credit) | ||
| Version | string | true | Account version |
| Property | Value |
| Name | AccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1100132415 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account name |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Maintenance Expenditures |
| Comments |
| Property | Value |
| Name | Project |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account Type (project aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Assets,Liabilities,Equity,Revenue,Expenses,Other (Non-Operating) Income and expenses |
| Sample | Assets |
| Comments |
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account category according to IBPDI charts of accounts (category aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Costs |
| Comments |
| Property | Value |
| Name | Group |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account group according IBPDI charts of accounts (group aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equipment |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-12-31 12:01:59 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2035-09-21 12:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | StatementType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Statement type (Balance statement or P&L account) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | BalanceStatement,P&L |
| Sample | P&L |
| Comments |
| Property | Value |
| Name | RecordType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Record type (Debit or Credit) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Debit,Credit |
| Sample | Debit |
| Comments |
| Property | Value |
| Name | Version |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account version |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 01.1 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Account",
"properties": {
"AccountId": {
"type": "string",
"description": "Account number",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"Name": {
"type": "string",
"description": "Account name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Project": {
"type": "string",
"description": "Account Type (project aligned with RICS naming convention)",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Assets",
"Liabilities",
"Equity",
"Revenue",
"Expenses",
"Other (Non-Operating) Income and expenses"
],
"maxLength": 50
},
"Category": {
"type": "string",
"description": "Account category according to IBPDI charts of accounts (category aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Group": {
"type": "string",
"description": "Account group according IBPDI charts of accounts (group aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"StatementType": {
"type": "string",
"description": "Statement type (Balance statement or P&L account)",
"enum": [
"BalanceStatement",
"P&L"
],
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RecordType": {
"type": "string",
"description": "Record type (Debit or Credit)",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Debit",
"Credit"
]
},
"Version": {
"type": "string",
"description": "Account version",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AccountId",
"Name",
"Project",
"Category",
"Group",
"ValidFrom",
"ValidUntil",
"StatementType",
"RecordType",
"Version"
]
}{
"AccountId": "1100132415",
"Name": "Maintenance Expenditures",
"Project": "Assets",
"Category": "Costs",
"Group": "Equipment",
"ValidFrom": "2021-12-31 12:01:59",
"ValidUntil": "2035-09-21 12:00:00",
"StatementType": "P&L",
"RecordType": "Debit",
"Version": "01.1"
}| Property | Value |
| Document name | CostCenter |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | dk | Internal paying party name/code | |
| Name | string | true | Name of cost center | ||
| Type | string | false | Type of cost center | ||
| Value | number | false | Value of cost center | [{"dataType":"float"}] | |
| IndividualAccountId | string | true | fk | Link to individual account | |
| OrganisationId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Internal paying party name/code |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of cost center |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Service Cost Center |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of cost center |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Service |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of cost center |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999 |
| Excl min | |
| Max value | 999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 24152.21 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to individual account |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to CostCenter. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to CostCenter. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenter",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Internal paying party name/code",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of cost center",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of cost center",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of cost center",
"minimum": -999999999,
"maximum": 999999999
},
"IndividualAccountId": {
"type": "string",
"description": "Link to individual account",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"Name",
"IndividualAccountId"
]
}{
"CostCenterId": "189000006",
"Name": "Service Cost Center",
"Type": "Service",
"Value": 24152.21,
"IndividualAccountId": "1890627182",
"OrganisationId": "BM2016271"
}| Property | Value |
| Document name | CostCenterBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(36) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to CostCenterBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterBuilding",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"BuildingId"
]
}{
"CostCenterId": "189000006",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | CostCenterPortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(34) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Portfolio. to CostCenterPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterPortfolio",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"PortfolioId"
]
}{
"CostCenterId": "189000006",
"PortfolioId": "PF-03-01"
}| Property | Value |
| Document name | CostCenterRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(37) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | |
| Relationship type | |
| Relationship name | fk RentalUnit. to CostCenterRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterRentalUnit",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"RentalUnitId"
]
}{
"CostCenterId": "189000006",
"RentalUnitId": "B-RU-10293"
}| Property | Value |
| Document name | CostCenterSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(35) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to CostCenterSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterSite",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"SiteId"
]
}{
"CostCenterId": "189000006",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | IndividualAccount |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | dk | Individual Account number | |
| Name | string | true | Individual Account name | ||
| Project | string | true | Individual Account project (project aligned with RICS naming convention) | ||
| Category | string | true | Individual Account category (category aligned with RICS naming convention) | ||
| Group | string | true | Individual Account group (group aligned with RICS naming convention) | ||
| ValidFrom | date-time | true | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StatementType | string | true | Statement type (Balance statement or P&L account) | ||
| RecordType | string | true | Record type (Debit or Credit) | ||
| GAAP | string | false | GAAP type used (if applicable) | ||
| Version | string | true | Individual account version | ||
| AccountId | string | true | fk | Reference to account | |
| OrganisationId | string | true | fk | Reference to organisation |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account name |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Maintenance Costs |
| Comments |
| Property | Value |
| Name | Project |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account project (project aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Expenditures |
| Comments |
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account category (category aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Maintenance Costs |
| Comments |
| Property | Value |
| Name | Group |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account group (group aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equipment |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2035-09-21 12:12:34 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | StatementType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Statement type (Balance statement or P&L account) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | BalanceStatement,P&L |
| Sample | P&L |
| Comments |
| Property | Value |
| Name | RecordType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Record type (Debit or Credit) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Debit,Credit |
| Sample | Debit |
| Comments |
| Property | Value |
| Name | GAAP |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | GAAP type used (if applicable) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | IFRS |
| Comments |
| Property | Value |
| Name | Version |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual account version |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 01.1 |
| Comments |
| Property | Value |
| Name | AccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to account |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Account |
| Foreign field | AccountId |
| Relationship type | Foreign Key |
| Relationship name | fk Account. to IndividualAccount. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1100132415 |
| Comments |
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to organisation |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to AccountOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccount",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Individual Account name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Project": {
"type": "string",
"description": "Individual Account project (project aligned with RICS naming convention)",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"Category": {
"type": "string",
"description": "Individual Account category (category aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Group": {
"type": "string",
"description": "Individual Account group (group aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"StatementType": {
"type": "string",
"description": "Statement type (Balance statement or P&L account)",
"enum": [
"BalanceStatement",
"P&L"
],
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RecordType": {
"type": "string",
"description": "Record type (Debit or Credit)",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Debit",
"Credit"
]
},
"GAAP": {
"type": "string",
"description": "GAAP type used (if applicable)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Version": {
"type": "string",
"description": "Individual account version",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AccountId": {
"type": "string",
"description": "Reference to account",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"OrganisationId": {
"type": "string",
"description": "Reference to organisation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"Name",
"Project",
"Category",
"Group",
"ValidFrom",
"ValidUntil",
"StatementType",
"RecordType",
"Version",
"AccountId",
"OrganisationId"
]
}{
"IndividualAccountId": "1890627182",
"Name": "Maintenance Costs",
"Project": "Expenditures",
"Category": "Maintenance Costs",
"Group": "Equipment",
"ValidFrom": "2021-03-21 00:00:00",
"ValidUntil": "2035-09-21 12:12:34",
"StatementType": "P&L",
"RecordType": "Debit",
"GAAP": "IFRS",
"Version": "01.1",
"AccountId": "1100132415",
"OrganisationId": "BM2016271"
}| Property | Value |
| Document name | IndividualAccountBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Individual Account number | |
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to TransactionBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to TransactionBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountBuilding",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"BuildingId"
]
}{
"IndividualAccountId": "1890627182",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | IndividualAccountPortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Individual Account number | |
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to IndividualAccountPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Portfolio. to TransactionPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountPortfolio",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"PortfolioId"
]
}{
"IndividualAccountId": "1890627182",
"PortfolioId": "PF-03-01"
}| Property | Value |
| Document name | IndividualAccountSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Individual Account number | |
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to TransactionSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to TransactionSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountSite",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"SiteId"
]
}{
"IndividualAccountId": "1890627182",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | Transaction |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| TransactionId | string | true | Transaction number | ||
| Type | string | true | Type of transaction | ||
| BookingType | string | true | Booking type | ||
| Value | number | true | Cost/Income value of specific transaction | [{"dataType":"float"}] | |
| BookingCurrency | string | true | Currency of booking | ||
| PostingDate | date-time | true | Date transaction is posted in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| DocumentId | string | false | Reference to document | does not exist yet | |
| CostCenterId | string | true | fk | Reference to cost center |
| Property | Value |
| Name | TransactionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Transaction number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 887332968 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of transaction |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Actual,Budget,Forecast |
| Sample | Actual |
| Comments |
| Property | Value |
| Name | BookingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Booking type |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | debit,credit |
| Sample | debit |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Cost/Income value of specific transaction |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999 |
| Excl min | |
| Max value | 999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1381 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | BookingCurrency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of booking |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
| Property | Value |
| Name | PostingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date transaction is posted in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-07 12:11:34 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to document |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to cost center |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to Transaction. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Transaction",
"properties": {
"TransactionId": {
"type": "string",
"description": "Transaction number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of transaction",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Actual",
"Budget",
"Forecast"
]
},
"BookingType": {
"type": "string",
"description": "Booking type",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"debit",
"credit"
]
},
"Value": {
"type": "number",
"description": "Cost/Income value of specific transaction",
"minimum": -999999999,
"maximum": 999999999
},
"BookingCurrency": {
"type": "string",
"description": "Currency of booking",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PostingDate": {
"type": "string",
"description": "Date transaction is posted in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"DocumentId": {
"type": "string",
"description": "Reference to document",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CostCenterId": {
"type": "string",
"description": "Reference to cost center",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TransactionId",
"Type",
"BookingType",
"Value",
"BookingCurrency",
"PostingDate",
"CostCenterId"
]
}{
"TransactionId": "887332968",
"Type": "Actual",
"BookingType": "debit",
"Value": 1381,
"BookingCurrency": "Euro",
"PostingDate": "2021-04-07 12:11:34",
"DocumentId": "Lorem",
"CostCenterId": "189000006"
}| Property | Value |
| Group name | OrganisationalManagement |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
| Property | Value |
| Document name | Address |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of address | ||
| StreetName | string | true | Name of the street | ||
| HouseNumber | string | false | House number of the street | ||
| AdditionalInformation | string | false | Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. | ||
| Appartment/Unit | string | false | Unit number | ||
| District | string | false | Boroughs or districts within a city that serve some official purpose | ||
| City | string | true | Any official settlement including cities, towns, villages, hamlets, localities, etc. | ||
| PostalCode | string | false | Postal codes used for mail sorting | ||
| StateProvincePrefecture | string | false | First-level administrative division, depending on the continent or country if might be named differently. | ||
| Country | string | true | Sovereign nations and their dependent territories, anything with an ISO-3166 code |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of address |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Postal address |
| Comments |
| Property | Value |
| Name | StreetName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of the street |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 128 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Friedrichsstraße |
| Comments |
| Property | Value |
| Name | HouseNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | House number of the street |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 32 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 78a |
| Comments |
| Property | Value |
| Name | AdditionalInformation |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Building A |
| Comments |
| Property | Value |
| Name | Appartment/Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit number |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C602 |
| Comments |
| Property | Value |
| Name | District |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Boroughs or districts within a city that serve some official purpose |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Brooklyn |
| Comments |
| Property | Value |
| Name | City |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Any official settlement including cities, towns, villages, hamlets, localities, etc. |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Berlin |
| Comments |
| Property | Value |
| Name | PostalCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Postal codes used for mail sorting |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 10 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 10117 |
| Comments |
| Property | Value |
| Name | StateProvincePrefecture |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | First-level administrative division, depending on the continent or country if might be named differently. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Bayern |
| Comments |
| Property | Value |
| Name | Country |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Sovereign nations and their dependent territories, anything with an ISO-3166 code |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Germany |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Address",
"additionalProperties": false,
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of address",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StreetName": {
"type": "string",
"description": "Name of the street",
"minLength": 1,
"maxLength": 128,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"HouseNumber": {
"type": "string",
"description": "House number of the street",
"minLength": 1,
"maxLength": 32,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AdditionalInformation": {
"type": "string",
"description": "Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. ",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Appartment/Unit": {
"type": "string",
"description": "Unit number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"District": {
"type": "string",
"description": "Boroughs or districts within a city that serve some official purpose",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"City": {
"type": "string",
"description": "Any official settlement including cities, towns, villages, hamlets, localities, etc.",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PostalCode": {
"type": "string",
"description": "Postal codes used for mail sorting",
"minLength": 1,
"maxLength": 10,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StateProvincePrefecture": {
"type": "string",
"description": " First-level administrative division, depending on the continent or country if might be named differently.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Country": {
"type": "string",
"description": "Sovereign nations and their dependent territories, anything with an ISO-3166 code",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"Type",
"StreetName",
"City",
"Country"
]
}{
"AddressId": "AD-9281928",
"Type": "Postal address",
"StreetName": "Friedrichsstraße",
"HouseNumber": "78a",
"AdditionalInformation": "Building A",
"Appartment/Unit": "C602",
"District": "Brooklyn",
"City": "Berlin",
"PostalCode": "10117",
"StateProvincePrefecture": "Bayern",
"Country": "Germany"
}| Property | Value |
| Document name | AddressBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(51) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to AddressBuilding. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressBuilding",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"AddressId",
"BuildingId"
]
}{
"AddressId": "AD-9281928",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | AddressContact |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| ContactId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | fk Address. to AddressContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Contact |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Contact. to AddressContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BP-00441 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressContact",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"ContactId"
]
}{
"AddressId": "AD-9281928",
"ContactId": "BP-00441"
}| Property | Value |
| Document name | AddressLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(54) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to AddressLand. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressLand",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"LandId"
]
}{
"AddressId": "AD-9281928",
"LandId": "RE-AT-05"
}| Property | Value |
| Document name | AddressOrganisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| OrganisationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | fk Address. to AddressOrganisation. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | |
| Relationship name | fk Organisation. to AddressOrganisation. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressOrganisation",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"OrganisationId"
]
}{
"AddressId": "AD-9281928",
"OrganisationId": "BM2016271"
}| Property | Value |
| Document name | AddressRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(52) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | |
| Relationship type | |
| Relationship name | fk RentalUnit. to AddressRentalUnit. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressRentalUnit",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"RentalUnitId"
]
}{
"AddressId": "AD-9281928",
"RentalUnitId": "B-RU-10293"
}| Property | Value |
| Document name | AddressSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(50) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to AddressSite. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressSite",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"SiteId"
]
}{
"AddressId": "AD-9281928",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | Contact |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ContactId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Salutation | string | false | Title of Business Partner | ||
| JobTitle | string | false | Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns | ||
| FirstName | string | true | First Name of Business Partner or responsible contact person | ||
| LastName | string | true | Surname of Business Partner or responsible contact person | ||
| EmployeeId | string | false | Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation | ||
| false | |||||
| Telephone | string | false | Phone number of business partner/ contact person | ||
| Fax | string | false | Fax number of business partner/ contact person | ||
| ValidFrom | date-time | false | For internal reference to recored employed since in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | false | For internal reference to recored employed until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| OrganisationId | string | false | fk | Link to organisation |
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BP-00441 |
| Comments |
| Property | Value |
| Name | Salutation |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Title of Business Partner |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Dipl. -Ing. |
| Comments |
| Property | Value |
| Name | JobTitle |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Head of sales |
| Comments |
| Property | Value |
| Name | FirstName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | First Name of Business Partner or responsible contact person |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Randolph |
| Comments |
| Property | Value |
| Name | LastName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Surname of Business Partner or responsible contact person |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Müller |
| Comments |
| Property | Value |
| Name | EmployeeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | E-172831 |
| Comments |
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | mueller@google.com |
| Comments |
| Property | Value |
| Name | Telephone |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Phone number of business partner/ contact person |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 017663425123 |
| Comments |
| Property | Value |
| Name | Fax |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Fax number of business partner/ contact person |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 22228888 |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | For internal reference to recored employed since in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | For internal reference to recored employed until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2199-12-31 12:21:12 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to organisation |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to Contact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Contact",
"additionalProperties": false,
"properties": {
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Salutation": {
"type": "string",
"description": "Title of Business Partner",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JobTitle": {
"type": "string",
"description": "Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FirstName": {
"type": "string",
"description": "First Name of Business Partner or responsible contact person",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LastName": {
"type": "string",
"description": "Surname of Business Partner or responsible contact person",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 100
},
"EmployeeId": {
"type": "string",
"description": "Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Email": {
"type": "string",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 100,
"format": "email"
},
"Telephone": {
"type": "string",
"description": "Phone number of business partner/ contact person",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Fax": {
"type": "string",
"description": "Fax number of business partner/ contact person",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "For internal reference to recored employed since in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "For internal reference to recored employed until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"OrganisationId": {
"type": "string",
"description": "Link to organisation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ContactId",
"FirstName",
"LastName"
]
}{
"ContactId": "BP-00441",
"Salutation": "Dipl. -Ing.",
"JobTitle": "Head of sales",
"FirstName": "Randolph",
"LastName": "Müller",
"EmployeeId": "E-172831",
"Email": "mueller@google.com",
"Telephone": "017663425123",
"Fax": "22228888",
"ValidFrom": "2021-03-21 00:00:00",
"ValidUntil": "2199-12-31 12:21:12",
"OrganisationId": "BM2016271"
}| Property | Value |
| Document name | Organisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| OrganisationId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ParentOrganisationId | string | false | Link to parent organisation | ||
| Name | string | true | Name of organization | ||
| Industry | string | false | Industry of organisation | ||
| false | Email of organisation | ||||
| Telephone | string | false | Phone number of organisation | ||
| Fax | string | false | Fax number of organisation | ||
| VatNumber | string | true | Vat number of organisation | ||
| LegalEntity | boolean | true | Is the organisation an legal entity (Y/N) | ||
| FiscalYearStartDate | date-time | true | Start date of fiscal year for organisation in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
| Property | Value |
| Name | ParentOrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to parent organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of organization |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BuildingMinds |
| Comments |
| Property | Value |
| Name | Industry |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Industry of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Service Provider |
| Comments |
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Email of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | test@google.com |
| Comments |
| Property | Value |
| Name | Telephone |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Phone number of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 112 |
| Comments |
| Property | Value |
| Name | Fax |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Fax number of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 22228888 |
| Comments |
| Property | Value |
| Name | VatNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Vat number of organisation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 5 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DE123456789 |
| Comments |
| Property | Value |
| Name | LegalEntity |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the organisation an legal entity (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | FiscalYearStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Start date of fiscal year for organisation in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Organisation",
"properties": {
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ParentOrganisationId": {
"type": "string",
"description": "Link to parent organisation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of organization",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Industry": {
"type": "string",
"description": "Industry of organisation",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Email": {
"type": "string",
"description": "Email of organisation",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 100,
"format": "email"
},
"Telephone": {
"type": "string",
"description": "Phone number of organisation",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Fax": {
"type": "string",
"description": "Fax number of organisation",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"VatNumber": {
"type": "string",
"description": "Vat number of organisation",
"minLength": 5,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LegalEntity": {
"type": "boolean",
"description": "Is the organisation an legal entity (Y/N)"
},
"FiscalYearStartDate": {
"type": "string",
"description": "Start date of fiscal year for organisation in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
}
},
"required": [
"OrganisationId",
"Name",
"VatNumber",
"LegalEntity",
"FiscalYearStartDate"
]
}{
"OrganisationId": "BM2016271",
"ParentOrganisationId": "BM2016271",
"Name": "BuildingMinds",
"Industry": "Service Provider",
"Email": "test@google.com",
"Telephone": "112",
"Fax": "22228888",
"VatNumber": "DE123456789",
"LegalEntity": true,
"FiscalYearStartDate": "2021-03-01 00:00:00"
}| Property | Value |
| Document name | Role |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of Role e.g. Owner |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Role e.g. Owner |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Role",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Role e.g. Owner",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"Type"
]
}{
"RoleId": "R-01",
"Type": "Lorem"
}| Property | Value |
| Document name | RoleBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to OrganisationBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleBuilding",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"BuildingId"
]
}{
"RoleId": "R-01",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | RoleContact |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| ContactId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to RoleContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Contact |
| Foreign field | ContactId |
| Relationship type | |
| Relationship name | fk Contact. to RoleContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BP-00441 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleContact",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"ContactId"
]
}{
"RoleId": "R-01",
"ContactId": "BP-00441"
}| Property | Value |
| Document name | RoleLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to OrganisationLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleLand",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"LandId"
]
}{
"RoleId": "R-01",
"LandId": "RE-AT-05"
}| Property | Value |
| Document name | RoleOrganisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| OrganisationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to RoleContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | |
| Relationship name | fk Organisation. to RoleOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleOrganisation",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"OrganisationId"
]
}{
"RoleId": "R-01",
"OrganisationId": "BM2016271"
}| Property | Value |
| Document name | RolePortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Portfolio. to OrganisationPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RolePortfolio",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"PortfolioId"
]
}{
"RoleId": "R-01",
"PortfolioId": "PF-03-01"
}| Property | Value |
| Document name | RolePortfolioStrategy |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioStrategyId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationPortfolioStrategy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | PortfolioStrategyId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | fk Portfolio. to RolePortfolioStrategy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | x01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RolePortfolioStrategy",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioStrategyId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"PortfolioStrategyId"
]
}{
"RoleId": "R-01",
"PortfolioStrategyId": "x01"
}| Property | Value |
| Document name | RoleRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | fk RentalUnit. to OrganisationRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleRentalUnit",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"RentalUnitId"
]
}{
"RoleId": "R-01",
"RentalUnitId": "B-RU-10293"
}| Property | Value |
| Document name | RoleSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to OrganisationSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleSite",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"SiteId"
]
}{
"RoleId": "R-01",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | RoleValuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationValuation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to OrganisationValuation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleValuation",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"ValuationId"
]
}{
"RoleId": "R-01",
"ValuationId": "V021"
}| Property | Value |
| Group name | PortfolioAndAssetManagement |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
| Property | Value |
| Document name | Portfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| Name | string | true | Name of Portfolio | ||
| PortfolioCode | string | false | User specific Portfolio Code e.g: MR003 | ||
| Type | string | true | Type of the Portfolio | ||
| AssetCategory | string | false | Describes the asset category | ||
| OwnershipType | string | false | Describes the ownership structure of the portfolio | ||
| ValidFrom | date-time | true | Date portfolio was set up in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date the maturity of the portfolio has been reached in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PrimaryUsageType | string | false | Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner) | ||
| SecondaryUsageType | string | false | Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner) | ||
| MarketValue | number | false | Current market value of Portfolio | [{"dataType":"float"}] | |
| Currency | string | false | Main/default currency of portfolio (depending on user it should be able to change this) | ||
| IndividualAccountId | string | true | fk | Link to individual account |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Portfolio |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | South Germany |
| Comments |
| Property | Value |
| Name | PortfolioCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Portfolio Code e.g: MR003 |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | GS-012 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of the Portfolio |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | AssetCategory |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Describes the asset category |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Tangible |
| Comments |
| Property | Value |
| Name | OwnershipType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Describes the ownership structure of the portfolio |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Freehold |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date portfolio was set up in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-09-14 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date the maturity of the portfolio has been reached in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2050-09-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | PrimaryUsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Financial Assets |
| Comments |
| Property | Value |
| Name | SecondaryUsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Freehold |
| Comments |
| Property | Value |
| Name | MarketValue |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Current market value of Portfolio |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2617281.27 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Main/default currency of portfolio (depending on user it should be able to change this) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to individual account |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to Portfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Portfolio",
"additionalProperties": false,
"properties": {
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Portfolio ",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"PortfolioCode": {
"type": "string",
"description": "User specific Portfolio Code e.g: MR003",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of the Portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 75
},
"AssetCategory": {
"type": "string",
"description": "Describes the asset category",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OwnershipType": {
"type": "string",
"description": "Describes the ownership structure of the portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 25
},
"ValidFrom": {
"type": "string",
"description": "Date portfolio was set up in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date the maturity of the portfolio has been reached in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"PrimaryUsageType": {
"type": "string",
"description": "Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryUsageType": {
"type": "string",
"description": "Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"MarketValue": {
"type": "number",
"description": "Current market value of Portfolio",
"minimum": -999999999999,
"maximum": 999999999999
},
"Currency": {
"type": "string",
"description": "Main/default currency of portfolio (depending on user it should be able to change this)",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Link to individual account",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"Name",
"Type",
"ValidFrom",
"ValidUntil",
"IndividualAccountId"
]
}{
"PortfolioId": "PF-03-01",
"Name": "South Germany",
"PortfolioCode": "GS-012",
"Type": "Lorem",
"AssetCategory": "Tangible",
"OwnershipType": "Freehold",
"ValidFrom": "2021-09-14 00:00:00",
"ValidUntil": "2050-09-21 00:00:00",
"PrimaryUsageType": "Financial Assets",
"SecondaryUsageType": "Freehold",
"MarketValue": 2617281.27,
"Currency": "Euro",
"IndividualAccountId": "1890627182"
}| Property | Value |
| Document name | PortfolioBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | New Relationship(41) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to PortfolioBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioBuilding",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"BuildingId"
]
}{
"PortfolioId": "PF-03-01",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | PortfolioLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | New Relationship(42) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to PortfolioLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioLand",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"LandId"
]
}{
"PortfolioId": "PF-03-01",
"LandId": "AE-DE-02"
}| Property | Value |
| Document name | PortfolioSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | New Relationship(30) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to PortfolioSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioSite",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"SiteId"
]
}{
"PortfolioId": "PF-03-01",
"SiteId": "AE-DE-02"
}| Property | Value |
| Document name | PortfolioStrategy |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| PortfolioStrategyId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| Name | string | true | Name of Strategy (user specific) | ||
| InvestmentType | string | false | Type of Strategy | ||
| ValidFrom | date-time | true | Date Strategy was implemented in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date strategy has to be adapted by in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StrategyObjectiveTargetsSteering | string | true | Steering target type of Portfolio Strategy | ||
| StrategyObjectiveValuesSteering | number | true | Value of the portfolio strategy steering targets | [{"dataType":"float"}] | |
| StrategyObjectiveUnitSteering | string | true | Unit of strategy objective values steering | [{"dataType":"float"}] | |
| StrategyObjectiveTargets | string | false | Target type of Portfolio Strategy | ||
| StrategyObjectiveValues | number | false | Value of the portfolio strategy targets | [{"dataType":"float"}] | |
| StrategyObjectiveUnit | string | false | Unit of strategy objective values | ||
| Source | string | false | Source of Portfolio strategy | ||
| PortfolioId | string | true | fk | Link to Portfolio |
| Property | Value |
| Name | PortfolioStrategyId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | x01 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Strategy (user specific) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Core longterm value add |
| Comments |
| Property | Value |
| Name | InvestmentType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Strategy |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Value add |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date Strategy was implemented in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-09-14 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date strategy has to be adapted by in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2050-09-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | StrategyObjectiveTargetsSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Steering target type of Portfolio Strategy |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equity target |
| Comments |
| Property | Value |
| Name | StrategyObjectiveValuesSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of the portfolio strategy steering targets |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 6378123.45 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | StrategyObjectiveUnitSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of strategy objective values steering |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | StrategyObjectiveTargets |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Target type of Portfolio Strategy |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equity target |
| Comments |
| Property | Value |
| Name | StrategyObjectiveValues |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of the portfolio strategy targets |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 8000000 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | StrategyObjectiveUnit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of strategy objective values |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Source of Portfolio strategy |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Europe branch |
| Comments |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to Portfolio |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioStrategy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioStrategy",
"properties": {
"PortfolioStrategyId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Strategy (user specific)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"InvestmentType": {
"type": "string",
"description": "Type of Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date Strategy was implemented in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date strategy has to be adapted by in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"StrategyObjectiveTargetsSteering": {
"type": "string",
"description": "Steering target type of Portfolio Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StrategyObjectiveValuesSteering": {
"type": "number",
"description": "Value of the portfolio strategy steering targets",
"minimum": -999999999999,
"maximum": 999999999999
},
"StrategyObjectiveUnitSteering": {
"type": "string",
"description": "Unit of strategy objective values steering",
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 20
},
"StrategyObjectiveTargets": {
"type": "string",
"description": "Target type of Portfolio Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StrategyObjectiveValues": {
"type": "number",
"description": "Value of the portfolio strategy targets",
"minimum": -999999999999,
"maximum": 999999999999
},
"StrategyObjectiveUnit": {
"type": "string",
"description": "Unit of strategy objective values",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Source": {
"type": "string",
"description": "Source of Portfolio strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Link to Portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"PortfolioStrategyId",
"Name",
"ValidFrom",
"ValidUntil",
"StrategyObjectiveTargetsSteering",
"StrategyObjectiveValuesSteering",
"StrategyObjectiveUnitSteering",
"PortfolioId"
]
}{
"PortfolioStrategyId": "x01",
"Name": "Core longterm value add",
"InvestmentType": "Value add",
"ValidFrom": "2021-09-14 00:00:00",
"ValidUntil": "2050-09-21 00:00:00",
"StrategyObjectiveTargetsSteering": "Equity target",
"StrategyObjectiveValuesSteering": 6378123.45,
"StrategyObjectiveUnitSteering": "Euro",
"StrategyObjectiveTargets": "Equity target",
"StrategyObjectiveValues": 8000000,
"StrategyObjectiveUnit": "Euro",
"Source": "Europe branch",
"PortfolioId": "PF-03-01"
}| Property | Value |
| Document name | PortfolioUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | fk Portfolio. to PortfolioUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to PortfolioUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioUnit",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"UnitId"
]
}{
"PortfolioId": "PF-03-01",
"UnitId": "UN-SE-CH-2341-02"
}| Property | Value |
| Document name | Valuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PreviousValuationId | string | false | Link to previous valuation | ||
| Name | string | true | Name of valuation | ||
| Type | string | true | Type of valuation | ||
| ValidFrom | date-time | true | Date valuation is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date valuation has to be redone in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Description | string | false | Description of valuation implementation | ||
| Text | string | false | Text field | ||
| Keywords | string | false | Important keywords | ||
| URL | string | false | URL if existent | ||
| JurisdictionType | string | false | Type of Jurisdiction | ||
| ProfessionalStandard | string | false | Name of professional valuation standard used | ||
| AccountingStandard | string | false | Name of Accounting standard used | ||
| JurisdictionStandard | string | false | Name of Jurisdiction type used | ||
| Value | number | true | Value of Valuation | [{"dataType":"float"}] | |
| Unit | string | true | Unit of valuation | ||
| Assumptions | string | false | Concluded assumptions | ||
| SpecialAssumptions | string | false | Concluded special assumptions | ||
| Constrains | string | false | Existing constrains | ||
| Approach | string | false | Valuation approach | ||
| MaintenanceBacklog | boolean | false | Does a maintenance backlog exist (Y/N) | ||
| SingleTenant | boolean | false | Valuation of single tenant building (Y/N) | ||
| DiscountRate | number | false | Discount rate included | [{"dataType":"float"}] | |
| DiscountPremiums | number | false | Discount premiums included | [{"dataType":"float"}] | |
| Uncertainty | string | false | LoV for uncertainty | ||
| Liquidity | number | false | Amount of cash | [{"dataType":"float"}] | |
| SpaceEfficiency | string | false | Space usage efficiency | ||
| EnergyEfficiency | string | false | Stating the energy efficiency class | ||
| DocumentId | string | false | Link to document | does not exist yet |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
| Property | Value |
| Name | PreviousValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to previous valuation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V020 |
| Comments |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of valuation |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Comparative Valuation |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of valuation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Comparative method |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date valuation is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-09-14 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date valuation has to be redone in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2050-09-21 12:23:56 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | Description |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Description of valuation implementation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Text |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Text field |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Keywords |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Important keywords |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | URL |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | URL if existent |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | JurisdictionType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Jurisdiction |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RICS valuation |
| Comments |
| Property | Value |
| Name | ProfessionalStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of professional valuation standard used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | AccountingStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Accounting standard used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | IFRS |
| Comments |
| Property | Value |
| Name | JurisdictionStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Jurisdiction type used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Local legislation |
| Comments |
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of Valuation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 6378123.45 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of valuation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
| Property | Value |
| Name | Assumptions |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Concluded assumptions |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | SpecialAssumptions |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Concluded special assumptions |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Constrains |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Existing constrains |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Approach |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Valuation approach |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | MaintenanceBacklog |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Does a maintenance backlog exist (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | SingleTenant |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Valuation of single tenant building (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | DiscountRate |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Discount rate included |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Percentage |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 7.29 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | DiscountPremiums |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Discount premiums included |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Percentage |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2.87 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Uncertainty |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | LoV for uncertainty |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Liquidity |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Amount of cash |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 4539.27 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | SpaceEfficiency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Space usage efficiency |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | EnergyEfficiency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Stating the energy efficiency class |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | A |
| Comments |
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to document |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Valuation",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PreviousValuationId": {
"type": "string",
"description": "Link to previous valuation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of valuation ",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"Type": {
"type": "string",
"description": "Type of valuation",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date valuation is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date valuation has to be redone in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Description": {
"type": "string",
"description": "Description of valuation implementation",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Text": {
"type": "string",
"description": "Text field",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Keywords": {
"type": "string",
"description": "Important keywords",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"URL": {
"type": "string",
"description": "URL if existent",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JurisdictionType": {
"type": "string",
"description": "Type of Jurisdiction",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ProfessionalStandard": {
"type": "string",
"description": "Name of professional valuation standard used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AccountingStandard": {
"type": "string",
"description": "Name of Accounting standard used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JurisdictionStandard": {
"type": "string",
"description": "Name of Jurisdiction type used",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Value": {
"type": "number",
"description": "Value of Valuation",
"minimum": -999999999999,
"maximum": 999999999999
},
"Unit": {
"type": "string",
"description": "Unit of valuation",
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 20
},
"Assumptions": {
"type": "string",
"description": "Concluded assumptions",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpecialAssumptions": {
"type": "string",
"description": "Concluded special assumptions",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Constrains": {
"type": "string",
"description": "Existing constrains",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Approach": {
"type": "string",
"description": "Valuation approach",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MaintenanceBacklog": {
"type": "boolean",
"description": "Does a maintenance backlog exist (Y/N)"
},
"SingleTenant": {
"type": "boolean",
"description": "Valuation of single tenant building (Y/N)"
},
"DiscountRate": {
"type": "number",
"description": "Discount rate included",
"minimum": 0,
"maximum": 100
},
"DiscountPremiums": {
"type": "number",
"description": "Discount premiums included",
"minimum": 0,
"maximum": 100
},
"Uncertainty": {
"type": "string",
"description": "LoV for uncertainty",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Liquidity": {
"type": "number",
"description": "Amount of cash"
},
"SpaceEfficiency": {
"type": "string",
"description": "Space usage efficiency",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnergyEfficiency": {
"type": "string",
"description": "Stating the energy efficiency class",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
" DocumentId": {
"type": "string",
"description": "Link to document",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"Name",
"Type",
"ValidFrom",
"ValidUntil",
"Value",
"Unit"
]
}{
"ValuationId": "V021",
"PreviousValuationId": "V020",
"Name": "Comparative Valuation",
"Type": "Comparative method",
"ValidFrom": "2021-09-14 00:00:00",
"ValidUntil": "2050-09-21 12:23:56",
"Description": "Lorem",
"Text": "Lorem",
"Keywords": "Lorem",
"URL": "Lorem",
"JurisdictionType": "RICS valuation",
"ProfessionalStandard": "Lorem",
"AccountingStandard": "IFRS",
"JurisdictionStandard": "Local legislation",
"Value": 6378123.45,
"Unit": "Euro",
"Assumptions": "Lorem",
"SpecialAssumptions": "Lorem",
"Constrains": "Lorem",
"Approach": "Lorem",
"MaintenanceBacklog": true,
"SingleTenant": true,
"DiscountRate": 7.29,
"DiscountPremiums": 2.87,
"Uncertainty": "Lorem",
"Liquidity": 4539.27,
"SpaceEfficiency": "Lorem",
"EnergyEfficiency": "A",
" DocumentId": "Lorem"
}| Property | Value |
| Document name | ValuationAccount |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| IndividualAccountId | string | true | Individual Account number |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | |
| Relationship name | fk IndividualAccount. to ValuationAccount. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationAccount",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"IndividualAccountId"
]
}{
"ValuationId": "V021",
"IndividualAccountId": "1890627182"
}| Property | Value |
| Document name | ValuationBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to ValuationBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationBuilding",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"BuildingId"
]
}{
"ValuationId": "V021",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | ValuationLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| LandId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to ValuationLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationLand",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"LandId"
]
}{
"ValuationId": "V021",
"LandId": "RE-AT-05"
}| Property | Value |
| Document name | ValuationOperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| OperationalMeasurementGuid | string | true | Globally Unique Identifier number |
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | fk OperationalMeasurement. to ValuationOperationalMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationOperationalMeasurement",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"ValuationId",
"OperationalMeasurementGuid"
]
}{
"ValuationId": "V021",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6"
}| Property | Value |
| Group name | PropertyManagement |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
| Property | Value |
| Document name | Dunning |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| DunningId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| DunningLevel | string | true | Dunning level | ||
| DunningAmount | number | true | Dunning Amount | [{"dataType":"float"}] | |
| Currency | string | true | Currency of payment | ||
| PaymentAmount | number | true | Value of payment | [{"dataType":"float"}] | |
| InitialDueData | date-time | true | Initial due date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | ||
| PaymentDate | date-time | true | Payment date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | ||
| RentalPaymentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | DunningId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | D-B-RU-10293 |
| Comments |
| Property | Value |
| Name | DunningLevel |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Dunning level |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 3 |
| Comments |
| Property | Value |
| Name | DunningAmount |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Dunning Amount |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 359.65 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
| Property | Value |
| Name | PaymentAmount |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 130.22 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | InitialDueData |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Initial due date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-06-31 11:49:37 |
| Comments |
| Property | Value |
| Name | PaymentDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Payment date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-06-25 10:07:23 |
| Comments |
| Property | Value |
| Name | RentalPaymentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | RentalPayment |
| Foreign field | RentalPaymentId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalPayment. to Dunning. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RP-RC-6271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Dunning",
"properties": {
"DunningId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DunningLevel": {
"type": "string",
"description": "Dunning level",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DunningAmount": {
"type": "number",
"description": "Dunning Amount",
"minimum": 1,
"maximum": 999999
},
"Currency": {
"type": "string",
"description": "Currency of payment",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PaymentAmount": {
"type": "number",
"description": "Value of payment",
"minimum": 1,
"maximum": 999999
},
"InitialDueData": {
"type": "string",
"description": "Initial due date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"PaymentDate": {
"type": "string",
"description": "Payment date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"RentalPaymentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"DunningId",
"DunningLevel",
"DunningAmount",
"Currency",
"PaymentAmount",
"InitialDueData",
"PaymentDate",
"RentalPaymentId"
]
}{
"DunningId": "D-B-RU-10293",
"DunningLevel": "3",
"DunningAmount": 359.65,
"Currency": "Euro",
"PaymentAmount": 130.22,
"InitialDueData": "2021-06-31 11:49:37",
"PaymentDate": "2021-06-25 10:07:23",
"RentalPaymentId": "RP-RC-6271"
}| Property | Value |
| Document name | RentalContract |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| MainContractId | string | false | Main contract code | ||
| ContractCode | string | true | Contract Code (e.g. SAP) | ||
| ContractType | string | false | Contract type | ||
| CompanyCode | string | false | Company Code (e.g. SAP code) | ||
| ContractName | string | false | Contract name | ||
| ContractGroup | string | false | Contract group | ||
| RentBeginDate | date-time | true | Date original contract starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| RentEndDate | date-time | true | Date original contract ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date of first paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date of last paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PeriodOfNotice | string | false | Period of notice e.g. monthly; 3 month; 6 month etc. | ||
| PaymentInAdvance | boolean | true | Does the payment have to be conducted in advance (Y/N) | ||
| PaymentPeriod | string | true | Frequency of payment e.g. weekly, monthly, quarterly etc. | ||
| ShortTermLease | boolean | false | Is this a short term lease (Y/N) | ||
| TenantSector | string | false | Sector / Business area of the tenant | ||
| TurnoverReportingInterval | string | false | If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc. |
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
| Property | Value |
| Name | MainContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Main contract code |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
| Property | Value |
| Name | ContractCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract Code (e.g. SAP) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1870_1867_00093 |
| Comments |
| Property | Value |
| Name | ContractType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract type |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Operating Lease |
| Comments |
| Property | Value |
| Name | CompanyCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Company Code (e.g. SAP code) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1870 |
| Comments |
| Property | Value |
| Name | ContractName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract name |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Mainz Bürogebäude 6-0291 |
| Comments |
| Property | Value |
| Name | ContractGroup |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract group |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Munich Main Office |
| Comments |
| Property | Value |
| Name | RentBeginDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date original contract starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2018-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | RentEndDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date original contract ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of first paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 12:22:56 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of last paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 23:21:12 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | PeriodOfNotice |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Period of notice e.g. monthly; 3 month; 6 month etc. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 6 month |
| Comments |
| Property | Value |
| Name | PaymentInAdvance |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Does the payment have to be conducted in advance (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | PaymentPeriod |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Frequency of payment e.g. weekly, monthly, quarterly etc. |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | monthly |
| Comments |
| Property | Value |
| Name | ShortTermLease |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is this a short term lease (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | true |
| Sample | |
| Comments |
| Property | Value |
| Name | TenantSector |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Sector / Business area of the tenant |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Research & development |
| Comments |
| Property | Value |
| Name | TurnoverReportingInterval |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | quarterly |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContract",
"additionalProperties": false,
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MainContractId": {
"type": "string",
"description": "Main contract code",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractCode": {
"type": "string",
"description": "Contract Code (e.g. SAP)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 70
},
"ContractType": {
"type": "string",
"description": "Contract type",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CompanyCode": {
"type": "string",
"description": "Company Code (e.g. SAP code)",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractName": {
"type": "string",
"description": "Contract name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractGroup": {
"type": "string",
"description": "Contract group",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentBeginDate": {
"type": "string",
"description": "Date original contract starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"RentEndDate": {
"type": "string",
"description": "Date original contract ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"ValidFrom": {
"type": "string",
"description": "Date of first paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date of last paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"PeriodOfNotice": {
"type": "string",
"description": "Period of notice e.g. monthly; 3 month; 6 month etc.",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"PaymentInAdvance": {
"type": "boolean",
"description": "Does the payment have to be conducted in advance (Y/N)"
},
"PaymentPeriod": {
"type": "string",
"description": "Frequency of payment e.g. weekly, monthly, quarterly etc.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ShortTermLease": {
"type": "boolean",
"description": "Is this a short term lease (Y/N)",
"default": true
},
"TenantSector": {
"type": "string",
"description": "Sector / Business area of the tenant",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TurnoverReportingInterval": {
"type": "string",
"description": "If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"ContractCode",
"RentBeginDate",
"RentEndDate",
"ValidFrom",
"ValidUntil",
"PaymentInAdvance",
"PaymentPeriod"
]
}{
"RentalContractId": "RC-6271",
"MainContractId": "R-01",
"ContractCode": "1870_1867_00093",
"ContractType": "Operating Lease",
"CompanyCode": "1870",
"ContractName": "Mainz Bürogebäude 6-0291",
"ContractGroup": "Munich Main Office",
"RentBeginDate": "2018-09-01 00:00:00",
"RentEndDate": "2020-09-01 00:00:00",
"ValidFrom": "2020-09-01 12:22:56",
"ValidUntil": "2025-12-31 23:21:12",
"PeriodOfNotice": "6 month",
"PaymentInAdvance": true,
"PaymentPeriod": "monthly",
"ShortTermLease": true,
"TenantSector": "Research & development",
"TurnoverReportingInterval": "quarterly"
}| Property | Value |
| Document name | RentalContractRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalContractId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(43) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | |
| Relationship name | New Relationship(43) |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContractRentalUnit",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"RentalContractId"
]
}{
"RentalUnitId": "B-RU-10293",
"RentalContractId": "RC-6271"
}| Property | Value |
| Document name | RentalContractRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | |
| Relationship name | fk RentalContract. to RentalContractOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to RentalContractOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContractRole",
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"RoleId"
]
}{
"RentalContractId": "RC-6271",
"RoleId": "R-01"
}| Property | Value |
| Document name | RentalOption |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalOptionId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of option | ||
| SubType | string | true | Subtype of the option | ||
| ValidFrom | date-time | true | Date option is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date option is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| RentalContractId | string | true | fk | Reference to corresponding rental contract | |
| DocumentId | string | false | Reference to document | does not exist yet |
| Property | Value |
| Name | RentalOptionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | LO-RC-6271-1 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of option |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Contract extension |
| Comments |
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Subtype of the option |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Renewal |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date option is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 04:29:59 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date option is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to corresponding rental contract |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | RentalContract |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to LeaseOption. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to document |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalOption",
"properties": {
"RentalOptionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of option ",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SubType": {
"type": "string",
"description": "Subtype of the option",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date option is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date option is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"RentalContractId": {
"type": "string",
"description": "Reference to corresponding rental contract",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
" DocumentId": {
"type": "string",
"description": "Reference to document",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalOptionId",
"Type",
"SubType",
"ValidFrom",
"ValidUntil",
"RentalContractId"
]
}{
"RentalOptionId": "LO-RC-6271-1",
"Type": "Contract extension",
"SubType": "Renewal",
"ValidFrom": "2020-09-01 04:29:59",
"ValidUntil": "2025-12-31 00:00:00",
"RentalContractId": "RC-6271",
" DocumentId": "Lorem"
}| Property | Value |
| Document name | RentalPayment |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalPaymentId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ValidFrom | date-time | true | Starting date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | End date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Type | string | true | Type of lease payment | ||
| Currency | string | true | Currency of payment | ||
| ValueMonth | number | true | Value of payment per month | [{"dataType":"float"}] | |
| ValueYear | number | false | Value of payment per year | [{"dataType":"float"}] | |
| DiscountInPercentage | number | false | Discount percentage of payment | [{"dataType":"float"}] | |
| VatOpted | boolean | true | Is the vat payable (Y/N) | ||
| RentalContractId | string | true | fk | Reference to rental contract | |
| IndexId | string | false | Reference to index table | does not exist yet |
| Property | Value |
| Name | RentalPaymentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RP-RC-6271 |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Starting date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | End date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of lease payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Ancillary costs |
| Comments |
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
| Property | Value |
| Name | ValueMonth |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of payment per month |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 9999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 216.19 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | ValueYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of payment per year |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 99999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2594.28 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | DiscountInPercentage |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Discount percentage of payment |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Percent |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 4.53 |
| Comments | [{"dataType":"float"}] |
| Property | Value |
| Name | VatOpted |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the vat payable (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to rental contract |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | RentalContract |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to RentalPaymentId. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
| Property | Value |
| Name | IndexId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to index table |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalPayment",
"properties": {
"RentalPaymentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Starting date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "End date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"Type": {
"type": "string",
"description": "Type of lease payment",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Currency": {
"type": "string",
"description": "Currency of payment",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValueMonth": {
"type": "number",
"description": "Value of payment per month",
"minimum": 1,
"maximum": 9999999
},
"ValueYear": {
"type": "number",
"description": "Value of payment per year",
"minimum": 1,
"maximum": 99999999
},
"DiscountInPercentage": {
"type": "number",
"description": "Discount percentage of payment",
"minimum": 0,
"maximum": 100
},
"VatOpted": {
"type": "boolean",
"description": "Is the vat payable (Y/N)"
},
"RentalContractId": {
"type": "string",
"description": "Reference to rental contract",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndexId": {
"type": "string",
"description": "Reference to index table",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalPaymentId",
"ValidFrom",
"ValidUntil",
"Type",
"Currency",
"ValueMonth",
"VatOpted",
"RentalContractId"
]
}{
"RentalPaymentId": "RP-RC-6271",
"ValidFrom": "2020-09-01 00:00:00",
"ValidUntil": "2025-12-31 00:00:00",
"Type": "Ancillary costs",
"Currency": "Euro",
"ValueMonth": 216.19,
"ValueYear": 2594.28,
"DiscountInPercentage": 4.53,
"VatOpted": true,
"RentalContractId": "RC-6271",
"IndexId": "Lorem"
}| Property | Value |
| Document name | RentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of rental unit | ||
| RentalUnitCode | string | false | User specific RentalUnit Code | ||
| RentedOut | boolean | true | Is the RentalUnit rented out (Y/N) | ||
| UsageType | string | false | Usage type of the rental unit | ||
| Vacancy | boolean | false | Is the rental unit vacant (Y/N) |
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of rental unit |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Heinrich-Heinestr. C602 |
| Comments |
| Property | Value |
| Name | RentalUnitCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific RentalUnit Code |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DE-B-C602 |
| Comments |
| Property | Value |
| Name | RentedOut |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the RentalUnit rented out (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | UsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Usage type of the rental unit |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Office |
| Comments |
| Property | Value |
| Name | Vacancy |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the rental unit vacant (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnit",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of rental unit",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitCode": {
"type": "string",
"description": "User specific RentalUnit Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentedOut": {
"type": "boolean",
"description": "Is the RentalUnit rented out (Y/N)"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UsageType": {
"type": "string",
"description": "Usage type of the rental unit",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Vacancy": {
"type": "boolean",
"description": "Is the rental unit vacant (Y/N)"
}
},
"required": [
"Name",
"RentedOut",
"RentalUnitId"
]
}{
"Name": "Heinrich-Heinestr. C602",
"RentalUnitCode": "DE-B-C602",
"RentedOut": true,
"RentalUnitId": "B-RU-10293",
"UsageType": "Office",
"Vacancy": true
}| Property | Value |
| Document name | RentalUnitAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | fk AreaMeasurement. to RentalUnitSpace copy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitAreaMeasurement",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"AreaMeasurementId"
]
}{
"RentalUnitId": "B-RU-10293",
"AreaMeasurementId": "AM-CH-SE-2312"
}| Property | Value |
| Document name | RentalUnitBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(44) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to RentalUnitBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitBuilding",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"RentalUnitId",
"BuildingId"
]
}{
"RentalUnitId": "B-RU-10293",
"BuildingId": "SE-CH-2341"
}| Property | Value |
| Document name | RentalUnitFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | fk Floor. to RentalUnitFloor. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitFloor",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"FloorId"
]
}{
"RentalUnitId": "B-RU-10293",
"FloorId": "SE-CH-F-01"
}| Property | Value |
| Document name | RentalUnitLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to RentalUnitLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitLand",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"RentalUnitId",
"LandId"
]
}{
"RentalUnitId": "B-RU-10293",
"LandId": "RE-AT-05"
}| Property | Value |
| Document name | RentalUnitSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | fk Space. to RentalUnitSpace. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitSpace",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"SpaceId"
]
}{
"RentalUnitId": "B-RU-10293",
"SpaceId": "SE-CH-F-01-21"
}| Property | Value |
| Document name | RentalUnitUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to RentalUnitUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitUnit",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"UnitId"
]
}{
"RentalUnitId": "B-RU-10293",
"UnitId": "UN-SE-CH-2341-02"
}| Property | Value |
| Document name | TenantCommunication |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| TenantCommunicationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of communication | ||
| Medium | string | false | Medium of communication | ||
| Description | string | true | Description of communciation | ||
| ValidFrom | date-time | true | Date communication occurred in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | false | Date communication is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Status | string | true | Status of communication | ||
| RentalUnitId | string | true | fk | Link to rental unit |
| Property | Value |
| Name | TenantCommunicationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | TC-20561 |
| Comments |
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of communication |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Medium |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Medium of communication |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | Description |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Description of communciation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date communication occurred in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date communication is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 11:59:14 |
| Comments | [{"dataType":"dateTime"}] |
| Property | Value |
| Name | Status |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Status of communication |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to rental unit |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to TenantCommunication. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "TenantCommunication",
"properties": {
"TenantCommunicationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Medium": {
"type": "string",
"description": "Medium of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Description": {
"type": "string",
"description": "Description of communciation",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"ValidFrom": {
"type": "string",
"description": "Date communication occurred in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date communication is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"Status": {
"type": "string",
"description": "Status of communication",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Link to rental unit",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TenantCommunicationId",
"Type",
"Description",
"ValidFrom",
"Status",
"RentalUnitId"
]
}{
"TenantCommunicationId": "TC-20561",
"Type": "Lorem",
"Medium": "Lorem",
"Description": "Lorem",
"ValidFrom": "2020-09-01 00:00:00",
"ValidUntil": "2025-12-31 11:59:14",
"Status": "Lorem",
"RentalUnitId": "B-RU-10293"
}| Property | Value |
| Document name | TenantCommunicationRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| TenantCommunicationId | string | true | |||
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
| Property | Value |
| Name | TenantCommunicationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | TenantCommunication |
| Foreign field | TenantCommunicationId |
| Relationship type | |
| Relationship name | fk TenantCommunication. to TenantCommunication. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | TC-20561 |
| Comments |
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to TenantCommunicationRole. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "TenantCommunicationRole",
"properties": {
"TenantCommunicationId": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TenantCommunicationId",
"RoleId"
]
}{
"TenantCommunicationId": "TC-20561",
"RoleId": "R-01"
}| Property | Value |
| Name | New Relationship(1) |
| Description | |
| Parent Document | Servitudes |
| Parent field | ServitudeId |
| Parent Cardinality | 1 |
| Child Document | Land |
| Child field | ServitudeId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(10) |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | SiteAreaMeasurement |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| SiteAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | New Relationship(10) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | SiteAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(11) |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | LandAreaMeasurement |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| LandAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | New Relationship(11) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | LandAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(12) |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | UnitAreaMeasurement |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| UnitAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | New Relationship(12) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | UnitAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(14) |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | BuildingUnit |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(14) |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | BuildingUnit |
| Child field | UnitId |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| EmissionFactor | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(18) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactor |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 1..n |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| GhgEmissions | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(19) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | GhgEmissions |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 1..n |
| Comments |
| Property | Value |
| Name | New Relationship(2) |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | Floor |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorGuid |
| Child Table | Child field |
| EmissionFactorSite | EmissionFactorGuid |
| Property | Value |
| Name | New Relationship(21) |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorSite |
| Child field | EmissionFactorGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorGuid |
| Child Table | Child field |
| EmissionFactorBuilding | EmissionFactorGuid |
| Property | Value |
| Name | New Relationship(22) |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBuilding |
| Child field | EmissionFactorGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| GhgEmissions | GhgEmissionsGuid |
| Child Table | Child field |
| GhgEmissionsSite | GhgEmissionsGuid |
| Property | Value |
| Name | New Relationship(23) |
| Description | |
| Parent Document | GhgEmissions |
| Parent field | GhgEmissionsGuid |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsSite |
| Child field | GhgEmissionsGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| GhgEmissions | GhgEmissionsGuid |
| Child Table | Child field |
| GhgEmissionsBuilding | GhgEmissionsGuid |
| Property | Value |
| Name | New Relationship(24) |
| Description | |
| Parent Document | GhgEmissions |
| Parent field | GhgEmissionsGuid |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsBuilding |
| Child field | GhgEmissionsGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementSite | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(25) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSite |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementLand | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(26) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementLand |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementBuilding | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(27) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementBuilding |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementFloor | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(28) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementFloor |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementUnit | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(28) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementUnit |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementSpace | OperationalMeasurementGuid |
| Property | Value |
| Name | New Relationship(29) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSpace |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(30) |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioSite |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(31) |
| Description | |
| Parent Document | Climate |
| Parent field | ClimateGuid |
| Parent Cardinality | 1 |
| Child Document | ClimateSite |
| Child field | ClimateGuid |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(32) |
| Description | |
| Parent Document | Climate |
| Parent field | ClimateGuid |
| Parent Cardinality | 1 |
| Child Document | ClimateBuilding |
| Child field | ClimateGuid |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorGuid |
| Child Table | Child field |
| EmissionFactorBusinessPartner | EmissionFactorGuid |
| Property | Value |
| Name | New Relationship(33) |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBusinessPartner |
| Child field | EmissionFactorGuid |
| Child Cardinality | 0..1 |
| Comments |
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterPortfolio | CostCenterId |
| Property | Value |
| Name | New Relationship(34) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterPortfolio |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(35) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterSite |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterBuilding | CostCenterId |
| Property | Value |
| Name | New Relationship(36) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterBuilding |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterRentalUnit | CostCenterId |
| Property | Value |
| Name | New Relationship(37) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterRentalUnit |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(4) |
| Description | |
| Parent Document | |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurement |
| Child field | ValidFrom |
| Child Cardinality | 1 |
| Comments |
| Property | Value |
| Name | New Relationship(41) |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioBuilding |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(42) |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioLand |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalContractRentalUnit | RentalUnitId |
| Property | Value |
| Name | New Relationship(43) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalContractRentalUnit | RentalContractId |
| Property | Value |
| Name | New Relationship(43) |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRentalUnit |
| Child field | RentalContractId |
| Child Cardinality | 1..n |
| Comments |
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalUnitBuilding | RentalUnitId |
| Property | Value |
| Name | New Relationship(44) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitBuilding |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitLand |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitFloor |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitSpace |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalUnitAreaMeasurement | RentalUnitId |
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitAreaMeasurement |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(50) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressSite |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(51) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressBuilding |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(52) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressRentalUnit |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | New Relationship(54) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressLand |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| BuildingAreaMeasurement | BuildingId |
| Property | Value |
| Name | New Relationship(6) |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | BuildingAreaMeasurement |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| BuildingAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | New Relationship(6) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | BuildingAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(8) |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | FloorAreaMeasurement |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| FloorAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | New Relationship(8) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | FloorAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | New Relationship(9) |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | SpaceAreaMeasurement |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| SpaceAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | New Relationship(9) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | SpaceAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | fk Account. to IndividualAccount. |
| Description | |
| Parent Document | Account |
| Parent field | AccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccount |
| Child field | AccountId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Address. to AddressContact. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressContact |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Address. to AddressOrganisation. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressOrganisation |
| Child field | AddressId |
| Child Cardinality | 1..n |
| Comments |
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| RentalUnitAreaMeasurement | AreaMeasurementId |
| Property | Value |
| Name | fk AreaMeasurement. to RentalUnitSpace copy. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to AddressBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | AddressBuilding |
| Child field | BuildingId |
| Child Cardinality | 1 |
| Comments |
| Property | Value |
| Name | fk Building. to CertificateBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | CertificateBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to ClimateBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ClimateBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to ComponentBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ComponentBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to CostCenterBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | CostCenterBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to EmissionFactorSite. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorSite |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| OperationalMeasurementBuilding | BuildingId |
| Property | Value |
| Name | fk Building. to OperationalMeasurementBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to OrganisationBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | RoleBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to PortfolioBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | PortfolioBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to RentalUnitBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| SustainabilityIndicators | BuildingId |
| Property | Value |
| Name | fk Building. to SustainabilityIndicators. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | SustainabilityIndicators |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| IndividualAccountBuilding | BuildingId |
| Property | Value |
| Name | fk Building. to TransactionBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to ValuationBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ValuationBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Building. to gHgEmissionsBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateBuilding | CertificateId |
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateBuilding |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateComponent | CertificateId |
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateComponent |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateValuation | CertificateId |
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateValuation |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateSystem | CertificateId |
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateSystem |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to Certificate. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | Certificate |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Component | ComponentId |
| Child Table | Child field |
| CertificateComponent | ComponentId |
| Property | Value |
| Name | fk Component. to Certificate. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | CertificateComponent |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSpace |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentUnit |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentFloor |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentBuilding |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSite |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSystem |
| Child field | ComponentId |
| Child Cardinality | 1..n |
| Comments |
| Property | Value |
| Name | fk Contact. to AddressContact. |
| Description | |
| Parent Document | Contact |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | AddressContact |
| Child field | ContactId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Contact. to RoleContact. |
| Description | |
| Parent Document | Contact |
| Parent field | ContactId |
| Parent Cardinality | 1 |
| Child Document | RoleContact |
| Child field | ContactId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk CostCenter. to Transaction. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | Transaction |
| Child field | CostCenterId |
| Child Cardinality | 1..n |
| Comments |
| Property | Value |
| Name | fk Floor. to ComponentFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | ComponentFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Floor. to OperationalMeasurementFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Floor. to RentalUnitFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| CostCenter | IndividualAccountId |
| Property | Value |
| Name | fk IndividualAccount. to CostCenter. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | CostCenter |
| Child field | IndividualAccountId |
| Child Cardinality | 1..n |
| Comments |
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountPortfolio | IndividualAccountId |
| Property | Value |
| Name | fk IndividualAccount. to IndividualAccountPortfolio. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountPortfolio |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| Portfolio | IndividualAccountId |
| Property | Value |
| Name | fk IndividualAccount. to Portfolio. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | Portfolio |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountBuilding | IndividualAccountId |
| Property | Value |
| Name | fk IndividualAccount. to TransactionBuilding. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountBuilding |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountSite | IndividualAccountId |
| Property | Value |
| Name | fk IndividualAccount. to TransactionSite. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountSite |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| ValuationAccount | IndividualAccountId |
| Property | Value |
| Name | fk IndividualAccount. to ValuationAccount. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | ValuationAccount |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Land. to AddressLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | AddressLand |
| Child field | LandId |
| Child Cardinality | 1 |
| Comments |
| Property | Value |
| Name | fk Land. to OperationalMeasurementLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Land. to PortfolioLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | PortfolioLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Land. to RentalUnitLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Land. to ValuationLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | ValuationLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| ValuationOperationalMeasurement | OperationalMeasurementGuid |
| Property | Value |
| Name | fk OperationalMeasurement. to ValuationOperationalMeasurement. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | ValuationOperationalMeasurement |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| IndividualAccount | OrganisationId |
| Property | Value |
| Name | fk Organisation. to AccountOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccount |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| AddressOrganisation | OrganisationId |
| Property | Value |
| Name | fk Organisation. to AddressOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | AddressOrganisation |
| Child field | OrganisationId |
| Child Cardinality | 1..n |
| Comments |
| Property | Value |
| Name | fk Organisation. to Contact. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | Contact |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| CostCenter | OrganisationId |
| Property | Value |
| Name | fk Organisation. to CostCenter. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | CostCenter |
| Child field | OrganisationId |
| Child Cardinality | 1 |
| Comments |
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| RoleOrganisation | OrganisationId |
| Property | Value |
| Name | fk Organisation. to RoleOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | RoleOrganisation |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Portfolio. to CostCenterPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | CostCenterPortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Portfolio. to OrganisationPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RolePortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Portfolio. to PortfolioStrategy. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | PortfolioStrategy |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Portfolio. to PortfolioUnit. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioUnit |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Portfolio | PortfolioId |
| Child Table | Child field |
| RolePortfolioStrategy | PortfolioStrategyId |
| Property | Value |
| Name | fk Portfolio. to RolePortfolioStrategy. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolioStrategy |
| Child field | PortfolioStrategyId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Portfolio | [-1] |
| Child Table | Child field |
| IndividualAccountPortfolio | PortfolioId |
| Property | Value |
| Name | fk Portfolio. to TransactionPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountPortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk RentalContract. to LeaseOption. |
| Description | |
| Parent Document | RentalContract |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RentalOption |
| Child field | RentalContractId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalContractRole | RentalContractId |
| Property | Value |
| Name | fk RentalContract. to RentalContractOrganisation. |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRole |
| Child field | RentalContractId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk RentalContract. to RentalPaymentId. |
| Description | |
| Parent Document | RentalContract |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RentalPayment |
| Child field | RentalContractId |
| Child Cardinality | 1..n |
| Comments |
| Parent Table | Parent field |
| RentalPayment | RentalPaymentId |
| Child Table | Child field |
| Dunning | RentalPaymentId |
| Property | Value |
| Name | fk RentalPayment. to Dunning. |
| Description | |
| Parent Document | RentalPayment |
| Parent field | RentalPaymentId |
| Parent Cardinality | 1 |
| Child Document | Dunning |
| Child field | RentalPaymentId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk RentalUnit. to AddressRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | AddressRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 1 |
| Comments |
| Property | Value |
| Name | fk RentalUnit. to CostCenterRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | CostCenterRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk RentalUnit. to OrganisationRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RoleRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| TenantCommunication | RentalUnitId |
| Property | Value |
| Name | fk RentalUnit. to TenantCommunication. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunication |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to OperationalMeasurement. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurement |
| Child field | RoleId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | fk Role. to OperationalMeasurement. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBusinessPartner |
| Child field | RoleId |
| Child Cardinality | 0..1 |
| Comments |
| Property | Value |
| Name | fk Role. to OrganisationBuilding. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleBuilding |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to OrganisationPortfolioStrategy. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolioStrategy |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to OrganisationRentalUnit. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleRentalUnit |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to OrganisationRentalUnit. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolio |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to OrganisationValuation. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleValuation |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to RentalContractOrganisation. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRole |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to RoleContact. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleContact |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to RoleContact. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleOrganisation |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Role. to TenantCommunicationRole. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunicationRole |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to AddressSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | AddressSite |
| Child field | SiteId |
| Child Cardinality | 1 |
| Comments |
| Property | Value |
| Name | fk Site. to ClimateSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | ClimateSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to ComponentFloor(2). |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | ComponentSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to CostCenterSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | CostCenterSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to EmissionFactorBuilding. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBuilding |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to OperationalMeasurementSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to PortfolioSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | PortfolioSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to TransactionSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Site. to gHgEmissionsSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Space. to New Document. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | ComponentSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Space. to OperationalMeasurementSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Space. to RentalUnitSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk System. to CertificateSystem. |
| Description | |
| Parent Document | System |
| Parent field | SystemId |
| Parent Cardinality | 1 |
| Child Document | CertificateSystem |
| Child field | SystemId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk System. to ComponentSystem. |
| Description | |
| Parent Document | System |
| Parent field | SystemId |
| Parent Cardinality | 1 |
| Child Document | ComponentSystem |
| Child field | SystemId |
| Child Cardinality | 1..n |
| Comments |
| Parent Table | Parent field |
| TenantCommunication | TenantCommunicationId |
| Child Table | Child field |
| TenantCommunicationRole | TenantCommunicationId |
| Property | Value |
| Name | fk TenantCommunication. to TenantCommunication. |
| Description | |
| Parent Document | TenantCommunication |
| Parent field | TenantCommunicationId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunicationRole |
| Child field | TenantCommunicationId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Unit. to ComponentUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | ComponentUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Unit. to OperationalMeasurementUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Unit. to PortfolioUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | PortfolioUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Unit. to RentalUnitUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| CertificateValuation | ValuationId |
| Property | Value |
| Name | fk Valuation. to CertificateValuation. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | CertificateValuation |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Valuation. to OrganisationValuation. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | RoleValuation |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationAccount |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationBuilding |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationLand |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| ValuationOperationalMeasurement | ValuationId |
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationOperationalMeasurement |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |